docs: Cleanup Markdown
I was going through the new version of the docs and noticed a few problems. Mostly URLs that aren't linked, extra whitespace, and a few mis-spellings. I ran the files through `aspell check` and made some manual changes myself. These changes were tested locally with `mkdocs serve`
This commit is contained in:
parent
89624ee57d
commit
0b068c668a
|
|
@ -83,7 +83,7 @@ More documentation
|
|||
New! See the docs online at [Read The Docs (OSTree)](https://ostree.readthedocs.org/en/latest/ )
|
||||
|
||||
Some more information is available on the old wiki page:
|
||||
https://wiki.gnome.org/Projects/OSTree
|
||||
<https://wiki.gnome.org/Projects/OSTree>
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
|
|
|||
|
|
@ -3,17 +3,18 @@ Submitting patches
|
|||
|
||||
You can:
|
||||
|
||||
1. Send mail to ostree-list@gnome.org, with the patch attached
|
||||
1. Submit a pull request against https://github.com/GNOME/ostree
|
||||
1. Attach them to https://bugzilla.gnome.org/
|
||||
1. Send mail to <ostree-list@gnome.org>, with the patch attached
|
||||
1. Submit a pull request against <https://github.com/GNOME/ostree>
|
||||
1. Attach them to <https://bugzilla.gnome.org/>
|
||||
|
||||
Please look at "git log" and match the commit log style.
|
||||
Please look at `git log` and match the commit log style.
|
||||
|
||||
Running the test suite
|
||||
----------------------
|
||||
|
||||
Currently, ostree uses https://wiki.gnome.org/GnomeGoals/InstalledTests
|
||||
To run just ostree's tests:
|
||||
Currently, OSTree uses <https://wiki.gnome.org/GnomeGoals/InstalledTests>
|
||||
|
||||
To run just OSTree's tests:
|
||||
|
||||
./configure ... --enable-installed-tests
|
||||
gnome-desktop-testing-runner -p 0 ostree/
|
||||
|
|
@ -118,4 +119,3 @@ Instead do this:
|
|||
goto out;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ exactly one ref, which is stored in the `.origin` file for the
|
|||
deployment. The command `ostree admin upgrade`
|
||||
implements this.
|
||||
|
||||
o begin a simple upgrade, OSTree fetches the contents of the ref from
|
||||
To begin a simple upgrade, OSTree fetches the contents of the ref from
|
||||
the remote server. Suppose we're tracking a ref named
|
||||
`exampleos/buildmaster/x86_64-runtime`. OSTree fetches the URL
|
||||
`http://$example.com/repo/refs/exampleos/buildmaster/x86_64-runtime`,
|
||||
|
|
@ -56,11 +56,10 @@ checking it back out of the repo into a deployment.
|
|||
|
||||
Given a commit to deploy, OSTree first allocates a directory for
|
||||
it. This is of the form `/boot/loader/entries/ostree-$osname-$checksum.$serial.conf`.
|
||||
he $serial is normally 0, but if a
|
||||
The `$serial` is normally 0, but if a
|
||||
given commit is deployed more than once, it will be incremented.
|
||||
his is supported because the previous deployment may have
|
||||
configuration in `/etc`
|
||||
hat we do not want to use or overwrite.
|
||||
configuration in `/etc` that we do not want to use or overwrite.
|
||||
|
||||
Now that we have a deployment directory, a 3-way merge is
|
||||
performed between the (by default) currently booted deployment's
|
||||
|
|
@ -74,7 +73,7 @@ hardlink farm; the running system is untouched, and the bootloader
|
|||
configuration is untouched. We want to add this deployment o the
|
||||
"deployment list".
|
||||
|
||||
To support a more general case, OSTree supports atomic ransitioning
|
||||
To support a more general case, OSTree supports atomic transitioning
|
||||
between arbitrary sets of deployments, with the restriction that the
|
||||
currently booted deployment must always be in the new set. In the
|
||||
normal case, we have exactly one deployment, which is the booted one,
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ OSTree is designed to boot directly into exactly one deployment
|
|||
at a time; each deployment is intended to be a target for
|
||||
`chroot()` or equivalent.
|
||||
|
||||
### "osname": Group of deployments that share /var</title>
|
||||
### "osname": Group of deployments that share /var
|
||||
|
||||
Each deployment is grouped in exactly one "osname". From above, you
|
||||
can see that an osname is physically represented in the
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ or an unprivileged container.
|
|||
|
||||
## Static deltas
|
||||
|
||||
OSTree itself was originally focused on a continous delivery model, where
|
||||
OSTree itself was originally focused on a continuous delivery model, where
|
||||
client systems are expected to update regularly. However, many OS vendors
|
||||
would like to supply content that's updated e.g. once a month or less often.
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ object. Static deltas also support `from NULL`, where the client can
|
|||
more efficiently download a commit object from scratch.
|
||||
|
||||
Effectively, we're spending server-side storage (and one-time compute
|
||||
cost), and gaining efficiency in client network bandwith.
|
||||
cost), and gaining efficiency in client network bandwidth.
|
||||
|
||||
## Static delta repository layout
|
||||
|
||||
|
|
@ -99,7 +99,7 @@ management easier for filesystem tools
|
|||
|
||||
A delta is named `$(mbase64 $from)-$(mbase64 $to)`, for example
|
||||
`GpTyZaVut2jXFPWnO4LJiKEdRTvOw_mFUCtIKW1NIX0-L8f+VVDkEBKNc1Ncd+mDUrSVR4EyybQGCkuKtkDnTwk`,
|
||||
which in sha256 format is
|
||||
which in SHA256 format is
|
||||
`1a94f265a56eb768d714f5a73b82c988a11d453bcec3f985502b48296d4d217d-2fc7fe5550e410128d73535c77e98352b495478132c9b4060a4b8ab640e74f09`.
|
||||
|
||||
Finally, the actual content can be found in
|
||||
|
|
@ -160,7 +160,7 @@ a per-file delta algorithm called
|
|||
[bsdiff](https://github.com/mendsley/bsdiff) that most notably works
|
||||
well on executable code.
|
||||
|
||||
The current delta compiler scans for files with maching basenamesin
|
||||
The current delta compiler scans for files with matching basenames in
|
||||
each commit that have a similar size, and attempts a bsdiff between
|
||||
them. (It would make sense later to have a build system provide a
|
||||
hint for this - for example, files within a same package).
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ HTTP, and where the OS includes (if desired) an entirely
|
|||
separate mechanism to install applications, stored in `/var` if they're system global, or
|
||||
`/home` for per-user
|
||||
application installation. An example application mechanism is
|
||||
http://docker.io/
|
||||
<http://docker.io/>
|
||||
|
||||
However, it is entirely possible to use OSTree underneath a
|
||||
package system, where the contents of `/usr` are computed on the client.
|
||||
|
|
|
|||
Loading…
Reference in New Issue