mirror of
https://github.com/ostreedev/ostree.git
synced 2025-01-05 13:18:17 +03:00
docs: Fix various typos
This commit is contained in:
parent
a13509ee7d
commit
a89d011c0b
@ -30,14 +30,14 @@ the remote server. Suppose we're tracking a ref named
|
|||||||
which contains a SHA256 checksum. This determines the tree to deploy,
|
which contains a SHA256 checksum. This determines the tree to deploy,
|
||||||
and `/etc` will be merged from currently booted tree.
|
and `/etc` will be merged from currently booted tree.
|
||||||
|
|
||||||
If we do not have this commit, then, then we perform a pull process.
|
If we do not have this commit, then we perform a pull process.
|
||||||
At present (without static deltas), this involves quite simply just
|
At present (without static deltas), this involves quite simply just
|
||||||
fetching each individual object that we do not have, asynchronously.
|
fetching each individual object that we do not have, asynchronously.
|
||||||
Put in other words, we only download changed files (zlib-compressed).
|
Put in other words, we only download changed files (zlib-compressed).
|
||||||
Each object has its checksum validated and is stored in `/ostree/repo/objects/`.
|
Each object has its checksum validated and is stored in `/ostree/repo/objects/`.
|
||||||
|
|
||||||
Once the pull is complete, we have all the objects locally
|
Once the pull is complete, we have downloaded all the objects that we need
|
||||||
we need to perform a deployment.
|
to perform a deployment.
|
||||||
|
|
||||||
## Upgrades via external tools (e.g. package managers)
|
## Upgrades via external tools (e.g. package managers)
|
||||||
|
|
||||||
@ -50,7 +50,7 @@ locally, etc.
|
|||||||
|
|
||||||
At a practical level, most package managers today (`dpkg` and `rpm`)
|
At a practical level, most package managers today (`dpkg` and `rpm`)
|
||||||
operate "live" on the currently booted filesystem. The way they could
|
operate "live" on the currently booted filesystem. The way they could
|
||||||
work with OSTree is instead to take the list of installed packages in
|
work with OSTree is to, instead, take the list of installed packages in
|
||||||
the currently booted tree, and compute a new filesystem from that. A
|
the currently booted tree, and compute a new filesystem from that. A
|
||||||
later chapter describes in more details how this could work:
|
later chapter describes in more details how this could work:
|
||||||
[Adapting Existing Systems](adapting-existing.md).
|
[Adapting Existing Systems](adapting-existing.md).
|
||||||
|
@ -21,10 +21,10 @@ primarily on server-side concerns.
|
|||||||
## Build vs buy
|
## Build vs buy
|
||||||
|
|
||||||
Therefore, you need to either pick an existing tool for writing
|
Therefore, you need to either pick an existing tool for writing
|
||||||
content into an OSTree repository, or to write your own. An example
|
content into an OSTree repository, or write your own. An example
|
||||||
tool is [rpm-ostree](https://github.com/projectatomic/rpm-ostree) - it
|
tool is [rpm-ostree](https://github.com/coreos/rpm-ostree) - it
|
||||||
takes as input RPMs, and commits them (currently oriented for a server
|
takes as input RPMs, and commits them (currently oriented for
|
||||||
side, but aiming to do client side too).
|
server-side, but aiming to do client-side too).
|
||||||
|
|
||||||
## Initializing
|
## Initializing
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ at a time; each deployment is intended to be a target for
|
|||||||
Each deployment is grouped in exactly one "stateroot" (also known as an "osname");
|
Each deployment is grouped in exactly one "stateroot" (also known as an "osname");
|
||||||
the former term is preferred.
|
the former term is preferred.
|
||||||
|
|
||||||
From above, you can see that an stateroot is physically represented in the
|
From above, you can see that a stateroot is physically represented in the
|
||||||
`/ostree/deploy/$stateroot` directory. For example, OSTree can allow parallel
|
`/ostree/deploy/$stateroot` directory. For example, OSTree can allow parallel
|
||||||
installing Debian in `/ostree/deploy/debian` and Red Hat Enterprise Linux in
|
installing Debian in `/ostree/deploy/debian` and Red Hat Enterprise Linux in
|
||||||
`/ostree/deploy/rhel` (subject to operating system support, present released
|
`/ostree/deploy/rhel` (subject to operating system support, present released
|
||||||
|
@ -103,12 +103,11 @@ Since static deltas may not exist, the client first needs to attempt
|
|||||||
to locate one. Suppose a client wants to retrieve commit `${new}`
|
to locate one. Suppose a client wants to retrieve commit `${new}`
|
||||||
while currently running `${current}`.
|
while currently running `${current}`.
|
||||||
|
|
||||||
The first thing to understand is that in order to save space, these
|
In order to save space, these two commits are "modified base64" - the
|
||||||
two commits are "modified base64" - the `/` character is replaced with
|
`/` character is replaced with `_`.
|
||||||
`_`.
|
|
||||||
|
|
||||||
Like the commit objects, a "prefix directory" is used to make
|
Like the commit objects, a "prefix directory" is used to make
|
||||||
management easier for filesystem tools
|
management easier for filesystem tools.
|
||||||
|
|
||||||
A delta is named `$(mbase64 $from)-$(mbase64 $to)`, for example
|
A delta is named `$(mbase64 $from)-$(mbase64 $to)`, for example
|
||||||
`GpTyZaVut2jXFPWnO4LJiKEdRTvOw_mFUCtIKW1NIX0-L8f+VVDkEBKNc1Ncd+mDUrSVR4EyybQGCkuKtkDnTwk`,
|
`GpTyZaVut2jXFPWnO4LJiKEdRTvOw_mFUCtIKW1NIX0-L8f+VVDkEBKNc1Ncd+mDUrSVR4EyybQGCkuKtkDnTwk`,
|
||||||
|
@ -39,7 +39,7 @@ regenerate it from source code.
|
|||||||
A dirtree contains a sorted array of (filename, checksum)
|
A dirtree contains a sorted array of (filename, checksum)
|
||||||
pairs for content objects, and a second sorted array of
|
pairs for content objects, and a second sorted array of
|
||||||
(filename, dirtree checksum, dirmeta checksum), which are
|
(filename, dirtree checksum, dirmeta checksum), which are
|
||||||
subdirectories. These type of objects are stored as files
|
subdirectories. This type of object is stored as files
|
||||||
ending with `.dirtree` in the objects directory.
|
ending with `.dirtree` in the objects directory.
|
||||||
|
|
||||||
### Dirmeta objects
|
### Dirmeta objects
|
||||||
@ -56,7 +56,7 @@ Unlike the first three object types which are metadata, designed to be
|
|||||||
`mmap()`ed, the content object has a separate internal header and
|
`mmap()`ed, the content object has a separate internal header and
|
||||||
payload sections. The header contains uid, gid, mode, and symbolic
|
payload sections. The header contains uid, gid, mode, and symbolic
|
||||||
link target (for symlinks), as well as extended attributes. After the
|
link target (for symlinks), as well as extended attributes. After the
|
||||||
header, for regular files, the content follows. These parts toghether
|
header, for regular files, the content follows. These parts together
|
||||||
form the SHA256 hash for content objects. The content type objects in
|
form the SHA256 hash for content objects. The content type objects in
|
||||||
this format exist only in `archive` OSTree repositories. Today the
|
this format exist only in `archive` OSTree repositories. Today the
|
||||||
content part is gzip'ed and the objects are stored as files ending
|
content part is gzip'ed and the objects are stored as files ending
|
||||||
@ -102,7 +102,7 @@ systems.
|
|||||||
The `bare-user-only` mode is a variant to the `bare-user` mode. Unlike
|
The `bare-user-only` mode is a variant to the `bare-user` mode. Unlike
|
||||||
`bare-user`, neither ownership nor extended attributes are stored. These repos
|
`bare-user`, neither ownership nor extended attributes are stored. These repos
|
||||||
are meant to to be checked out in user mode (with the `-U` flag), where this
|
are meant to to be checked out in user mode (with the `-U` flag), where this
|
||||||
information is not applied anyway. Hence this mode may loose metadata.
|
information is not applied anyway. Hence this mode may lose metadata.
|
||||||
The main advantage of `bare-user-only` is that repos can be stored on
|
The main advantage of `bare-user-only` is that repos can be stored on
|
||||||
filesystems which do not support extended attributes, such as tmpfs.
|
filesystems which do not support extended attributes, such as tmpfs.
|
||||||
|
|
||||||
|
@ -106,8 +106,7 @@ want to "promote" that commit. Let's create a new branch called
|
|||||||
complete system. This might be where human testers get involved, for
|
complete system. This might be where human testers get involved, for
|
||||||
example.
|
example.
|
||||||
|
|
||||||
A basic way to "promote" the `buildmaster` commit that passed
|
This is a basic way to "promote" the `buildmaster` commit that passed testing:
|
||||||
testing like this:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
ostree commit -b exampleos/x86_64/smoketested/standard -s 'Passed tests' --tree=ref=aec070645fe53...
|
ostree commit -b exampleos/x86_64/smoketested/standard -s 'Passed tests' --tree=ref=aec070645fe53...
|
||||||
|
Loading…
Reference in New Issue
Block a user