summaryrefslogtreecommitdiff
path: root/Makefile-man.am
Commit message (Collapse)AuthorAgeFilesLines
* man: Create an HTML indexDan Nicholson2022-04-081-1/+4
| | | | | This provides something that can serve at the root of the HTML man pages tree.
* man: Use custom XSL stylesheet for HTML outputDan Nicholson2022-04-081-1/+2
| | | | | This allows using a template stolen from systemd to turn references into links.
* man: Allow building HTML man pagesDan Nicholson2022-04-081-3/+22
| | | | | | Add a --enable-man-html configure option to build HTML man pages using a different stylesheet. The HTML pages aren't installed as I don't know what purpose they'd serve on an actual installation.
* Update FSF license notices to use URL instead of addressJoseph Marrero2021-12-071-3/+1
|
* man: document `ostree sign`Denis Pynkin2020-03-251-1/+1
| | | | | | Add man page for `ostree sign`. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
* build-sys: Cleanup handling for trivial-httpd-cmdlineColin Walters2019-10-231-1/+1
| | | | | | | | | | | This way it's clearer this bit is only about the CLI entrypoint also living in `ostree trivial-httpd`, not the underlying `ostree-trivial-httpd` binary that's separate now. Delete the automake conditional for this, and make the manpage conditional use `if USE_LIBSOUP` the same way the C build does. Suggested-by: Jonathan Lebon <jonathan@jlebon.com>
* build: Conditionally build GPGME-related sourcesDenis Pynkin2019-08-011-1/+5
| | | | | | | | | Do not build GPGME-related sources if flag USE_GPGME is not defined. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com> Closes: #1889 Approved by: cgwalters
* Make P2P API public (no longer experimental)Matthew Leeds2018-06-041-9/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Currently the API that allows P2P operations (e.g. pulling an ostree ref from a LAN or USB source) is hidden behind the configure flag --enable-experimental-api. This commit makes the API public and makes that flag essentially a no-op (leaving it in place in case we want to use it again in the future). The P2P API has been tested over the last several months and proven to work. This means that since we're no longer using the "experimental" feature flag, P2P builds of Flatpak will fail when using versions of OSTree from this commit onwards, until Flatpak is patched in the near future. If you want to build Flatpak < 0.11.8 with P2P enabled and link against OSTree 2018.6, you'll have to patch Flatpak. However, since Flatpak won't yet have a hard dependency on OSTree 2018.6, it needs a new way to determine if the P2P API in OSTree is available, so this commit adds a "p2p" feature flag. This way the feature set is more semantically correct than if we had continued to use the "experimental" feature flag. In addition to making the P2P API public, this commit makes the P2P unit tests run by default, removes the f27-experimental CI instance that's no longer needed, changes a few man pages to reflect the changes, and updates the bash completion script to accept the new commands and options. Closes: #1596 Approved by: cgwalters
* man: Add man page for create-usbMatthew Leeds2018-04-191-1/+1
| | | | | Closes: #1543 Approved by: cgwalters
* sysroot: Add concept of deployment "pinning" đź“ŚColin Walters2018-02-261-0/+1
| | | | | | | | | | | | | Example user story: Jane rebases her OS to a new major version N, and wants to keep around N-1 even after a few upgrades for a while so she can easily roll back. I plan to add `rpm-ostree rebase --pin` to opt-in to this for example. Builds on the new `libostree-transient` group to store pinning state there. Closes: https://github.com/ostreedev/ostree/issues/1460 Closes: #1464 Approved by: jlebon
* Add SPDX-License-Identifier to source filesMarcus Folkesson2018-01-301-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | SPDX License List is a list of (common) open source licenses that can be referred to by a “short identifier”. It has several advantages compared to the common "license header texts" usually found in source files. Some of the advantages: * It is precise; there is no ambiguity due to variations in license header text * It is language neutral * It is easy to machine process * It is concise * It is simple and can be used without much cost in interpreted environments like java Script, etc. * An SPDX license identifier is immutable. * It provides simple guidance for developers who want to make sure the license for their code is respected See http://spdx.org for further reading. Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com> Closes: #1439 Approved by: cgwalters
* man: Add man page for find-remotesMatthew Leeds2018-01-151-0/+4
| | | | | Closes: #1410 Approved by: pwithnall
* build: Don't distribute generated man pagesSimon McVittie2017-07-181-1/+1
| | | | | | | | | | We build them in "make" and clean them in "make clean", so there doesn't seem much point in shipping them pre-generated in the tarball. Signed-off-by: Simon McVittie <smcv@debian.org> Closes: #1013 Approved by: cgwalters
* build: Always include ostree-trivial-httpd.xml in tarballsSimon McVittie2017-06-221-0/+3
| | | | | | | Signed-off-by: Simon McVittie <smcv@debian.org> Closes: #949 Approved by: cgwalters
* Don't install trivial-httpd man page if not enabledColin Walters2017-06-021-1/+4
| | | | | | | I just noticed this scroll by in a file listing. Closes: #905 Approved by: jlebon
* build: Actually distribute man page XML sourceDan Nicholson2016-09-011-1/+1
| | | | | | | | The make substitution pattern was wrong. The source files are "ostree.xml", not "ostree.1.xml", for instance. Closes: #488 Approved by: cgwalters
* build: Distribute man page XML sourceDan Nicholson2016-09-011-1/+1
| | | | | | | | Without this, the manual pages can't actually be regenerated from a dist tarball, and running make clean will remove all traces of them. Closes: #486 Approved by: cgwalters
* admin: Add an `unlock` command, and libostree APIColin Walters2016-03-231-1/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I'm trying to improve the developer experience on OSTree-managed systems, and I had an epiphany the other day - there's no reason we have to be absolutely against mutating the current rootfs live. The key should be making it easy to rollback/reset to a known good state. I see this command as useful for two related but distinct workflows: - `ostree admin unlock` will assume you're doing "development". The semantics hare are that we mount an overlayfs on `/usr`, but the overlay data is in `/var/tmp`, and is thus discarded on reboot. - `ostree admin unlock --hotfix` first clones your current deployment, then creates an overlayfs over `/usr` persistent to this deployment. Persistent in that now the initramfs switchroot tool knows how to mount it as well. In this model, if you want to discard the hotfix, at the moment you roll back/reboot into the clone. Note originally, I tried using `rofiles-fuse` over `/usr` for this, but then everything immediately explodes because the default (at least CentOS 7) SELinux policy denies tons of things (including `sshd_t` access to `fusefs_t`). Sigh. So the switch to `overlayfs` came after experimentation. It still seems to have some issues...specifically `unix_chkpwd` is broken, possibly because it's setuid? Basically I can't ssh in anymore. But I *can* `rpm -Uvh strace.rpm` which is handy. NOTE: I haven't tested the hotfix path fully yet, specifically the initramfs bits.
* Add an `export` builtin, and API to write to libarchiveColin Walters2016-02-141-1/+1
| | | | | | | | | | At the moment I'm looking at using rpm-ostree to manage RPM inputs which can then be converted into Docker images. It's most convenient if we can stream directly out of libostree rather than doing a checkout + tar combination. There are also backup/debugging etc. reasons to implement `export` as well.
* Import rofiles-fuseColin Walters2016-02-101-0/+4
| | | | | | | | | | | | | | | | | | While it's not strictly tied to OSTree, let's move https://github.com/cgwalters/rofiles-fuse in here because: - It's *very* useful in concert with OSTree - It's tiny - We can reuse OSTree's test, documentation, etc. infrastructure One thing to consider also is that at some point we could experiment with writing a FUSE filesystem for OSTree. This could internalize a better equivalent of `--link-checkout-speedup`, but on the other hand, the cost of walking filesystem trees for these types of operations is really quite small. But if we did decide to do more FUSE things in OSTree, this is a step towards that too.
* build: Hoist man conditional higherColin Walters2016-01-281-2/+2
| | | | So we actually build with `--disable-man`.
* build: Add --disable-manColin Walters2016-01-281-2/+2
| | | | Gnome Continuous doesn't have docbook, so copy what we do for glib.
* build: Move man pages into man/Colin Walters2016-01-281-0/+54
This is preparation for having 3 separate doc build systems (whee): - xsltproc for the man pages - gtk-doc for the API docs - mkdocs for a real manual