summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
...
* docs: Link to releng-scriptsColin Walters2016-10-271-5/+14
| | | | | | | Now that the repo starts to implement some of this stuff. Closes: #544 Approved by: jlebon
* docs: amend vmlinuz & initramfs naming conventionJonathan Lebon2016-10-141-7/+8
| | | | | | | | | I was confused while reading the docs how this could work, since in at least the Fedora/CentOS/RHEL distros, they're named e.g. initramfs-`uname -r`-$checksum. Closes: #529 Approved by: cgwalters
* docs: add mention of rpm-ostree package layeringJonathan Lebon2016-09-201-0/+3
| | | | | Closes: #514 Approved by: cgwalters
* repo: Revert default timestamp from 1 back to 0Colin Walters2016-09-081-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Quoting Dan Nicholson in <https://github.com/ostreedev/ostree/pull/330#issuecomment-245499099> mtime of 0 has been the semantics of ostree deployments from basically the beginning of the project. We (and others, see flatpak/flatpak@b5204c9) rely on that fact when generating trees. In particular, this affects caches that use the mtime of the associated file or directory to determine if the cache is valid. By arbitrarily changing the mtime of the files to something else, all the caches we setup in the build are now invalidated. Preseeding caches is really important to the user experience as it avoids having the user wait while they're regenerated on first run. Now, we could change our build infrastructure to preset all the mtimes to 1 to match this change, but what does that do for our existing users who are on an ostree that deploys with mtimes of 0? We could just revert this change at Endless (and the associated one in Flatpak), and that would be fine for our users. However, if we point non-Endless users to our apps, they'll have the great experience of waiting 10 seconds the first time they launch it while the fontconfig cache is rebuilt unnecessarily. Closes: #495 Approved by: jlebon
* fix typo in docs/manual/atomic-upgrades.mdAdam Miller2016-08-121-1/+1
| | | | | | | Signed-off-by: Adam Miller <maxamillion@fedoraproject.org> Closes: #460 Approved by: cgwalters
* manual/repo.md: reword bits about the summary fileJonathan Lebon2016-08-111-7/+7
| | | | | Closes: #459 Approved by: cgwalters
* docs/formats: Elaborate a bit on delta from NULL usageColin Walters2016-07-191-1/+4
| | | | | | | See discussion on ostree-list. Closes: #402 Approved by: gatispaeglis
* docs: Add a section on DockerColin Walters2016-07-041-0/+45
| | | | | | | | This could have a lot more obviously, but just laying down my thoughts as a starting point. Closes: #374 Approved by: jlebon
* manual: Discuss mirroringColin Walters2016-06-171-5/+27
| | | | | | | | This should likely be its own section, but it makes enough sense here for now too. Closes: #347 Approved by: yuqi-zhang
* manual: Link to mender.ioColin Walters2016-06-151-0/+5
| | | | | | | Came out of a discussion on the list. Closes: #344 Approved by: jlebon
* related-projects: Update with more information and projectsMathnerd3142016-06-091-31/+89
| | | | | | | | | In particular, NixOS has changed somewhat, and Conda is worth looking at. Also it seems reasonable to mention rpm-ostree / Gnome Continuous. Closes: #331 Approved by: cgwalters
* repo: use OSTREE_TIMESTAMP (=1) for checked-out filesMathnerd3142016-06-091-0/+16
| | | | | | | | | 1 is a better choice than 0 because some programs use 0 as a special value; for example, GNU Tar warns of an "implausibly old timestamp" with 0. Closes: #330 Approved by: cgwalters
* docs: fix swapped link syntaxMicah Abbott2016-05-123-5/+4
| | | | | | | | | | | A few links in the docs had the Markdown syntax swapped like: (link title)[link url] Just cleaned up those. Verified via `mkdocs serve` Closes: #297 Approved by: cgwalters
* small cleanupsJonathan Lebon2016-04-081-1/+1
| | | | | | | | | - Revert 'cannot' --> 'can not' (it's the exception!) - Remove duplicate function - Squelch compiler warnings Closes: #248 Approved by: cgwalters
* docs: Prefer the form "cannot" to "can not"Giuseppe Scrivano2016-04-072-2/+2
| | | | | | | Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com> Closes: #242 Approved by: cgwalters
* Remove empty new lines at the EOFGiuseppe Scrivano2016-04-071-3/+0
| | | | | | | Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com> Closes: #242 Approved by: cgwalters
* manual: Fix a bunch of typos and docbookismsKrzesimir Nowak2016-04-046-26/+26
| | | | | Closes: #238 Approved by: cgwalters
* docs/CONTRIBUTING.md: Update for github move, Homu etc.Colin Walters2016-03-301-14/+31
| | | | | Closes: #230 Approved by: jlebon
* docs: Add a section on repository managementColin Walters2016-03-292-0/+219
| | | | | | | | Just keeping my promise to write more documentation. There could be a lot more to write here, but I'm trying to get a start done. Closes: #222 Approved by: jlebon
* deploy: Handle a read-only /bootColin Walters2016-03-211-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | I'd like to encourage people to make OSTree-managed systems more strictly read-only in multiple places. Ideally everywhere is read-only normally besides `/var/`, `/tmp/`, and `/run`. `/boot` is a good example of something to make readonly. Particularly now that there's work on the `admin unlock` verb, we need to protect the system better against things like `rpm -Uvh kernel.rpm` because the RPM-packaged kernel won't understand how to do OSTree right. In order to make this work of course, we *do* need to remount `/boot` as writable when we're doing an upgrade that changes the kernel configuration. So the strategy is to detect whether it's read-only, and if so, temporarily mount read-write, then remount read-only when the upgrade is done. We can generalize this in the future to also do `/etc` (and possibly `/sysroot/ostree/` although that gets tricky). One detail: In order to detect "is this path a mountpoint" is nontrivial - I looked at copying the systemd code, but the right place is to use `libmount` anyways.
* manual: Migrate related projects wiki page into manualColin Walters2016-03-181-0/+207
| | | | | | | | | | This content currently lives here: <https://wiki.gnome.org/Projects/OSTree/RelatedProjects>. Moving it into the manual in Markdown: - Makes it look better - It's more useful alongside the rest of the docs - Is much less crummy in general than the GNOME wiki
* docs: Add a section on writing buildsystemsColin Walters2016-03-161-0/+180
| | | | And add a test that is a demo buildsystem.
* docs: Cleanup MarkdownMicah Abbott2016-03-167-36/+35
| | | | | | | | | | | 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`
* docs: Reference the git docs on referencesColin Walters2016-03-091-3/+7
|
* docs/introduction: Note VMs vs baremetalColin Walters2016-03-031-0/+7
|
* docs: Add a blurb on the summary fileColin Walters2016-02-271-0/+27
| | | | We expect people to use it now, so let's actually describe what it is.
* docs: Add a new formats section, move static deltas in thereColin Walters2016-02-221-0/+181
| | | | | The `src/libostree/README-deltas.md` was rather hidden - let's move this into the manual.
* manual: Note that the bare-user mode existsColin Walters2016-02-181-8/+17
|
* Rewrite manual in mkdocsColin Walters2016-01-287-0/+678
I don't much like Docbook (and am considering converting the man pages too), but let's start with the manual. I looked at various documentation generators (there are a lot), and I had a few requirements: - Markdown - Packaged in Fedora - Suitable for upload to a static webserver `mkdocs` seems to fit the bill.
View Lorry Controller Status