Commit Graph

374 Commits (7ac5d41bea2d9e918a084ee4bcf18d3d5f7239fb)

Author SHA1 Message Date
Alexander Larsson 461084d1a9 builder: Add a install-rule to allow customized install
Fixes: https://github.com/flatpak/flatpak/issues/791
2017-05-15 09:38:22 +02:00
Matthias Clasen 514886dd13 Document flatpakref format extensions
gnome-software is reading some extra keys. Document them.
2017-05-12 12:27:16 +02:00
Matthias Clasen b232c9e1fa Document flatpakrepo format extensions
gnome-software is reading some extra keys. Document them.
2017-05-12 12:27:16 +02:00
Matthias Clasen b6ffa5aecb Document is-set keys in repo config 2017-05-10 11:53:33 +02:00
Matthias Clasen e8836b0b52 Update docs for build-update-repo
Mention both --import-gpg and --redirect-url.
2017-05-10 11:53:33 +02:00
Matthias Clasen 172d7ad9db Use clearer terminology in docs about extensions
Differentiate between the 'extension point' (definition of
a place where extensions can be mounted) and the 'extension'
(a runtime matching an extension point).
2017-05-08 11:28:55 +02:00
Alexander Larsson f228577377 run: Handle forwarding uris better
We need to know if we're forwarding uris or files, because
if we're doing uris we need to pass on non-file uris as-is.
So, we enclose uris with "@@u @@" instead.

This also properly (un)escapes the file uris
2017-05-03 13:53:39 +02:00
Matthias Clasen 00e166250f Document the --file-forwarding option
This commit also documents the handling of rest arguments.
Previously, there was no information about what happens to ARG...
2017-05-03 13:27:52 +02:00
AsciiWolf 5e854403f6 Fix man page typo 2017-05-03 12:39:52 +02:00
Matthias Clasen 52f7d1b0f5 Update the man page a bit 2017-05-03 11:07:52 +02:00
Matthias Clasen 17dd7b7861 Revise the flatpak repo command slightly
Make --info only print out general information, and add a new
option --branches which lists the per-branch information.
2017-05-02 14:56:04 +02:00
Matthias Clasen 1137c64bf6 Document some environment variables (#754)
* Document some environment variables

These are only the most 'official' looking ones.
2017-05-02 14:52:51 +02:00
Tanu Kaskinen e12b4ba362 docs: Typo fix: "flatpack-builder" -> "flatpak-builder" 2017-04-20 20:53:59 +03:00
Alexander Larsson df2cb9310f docs: Mention that rename-icon should not have an extension
Fixes https://github.com/flatpak/flatpak/issues/591
2017-04-19 20:58:00 +02:00
Matthias Clasen ca40b26ce7 More metadata docs
Document the ExtensionOf and Extra Data groups.
2017-04-19 09:09:36 +02:00
Matthias Clasen 958d02abd5 Document build-extension
Not much to say here, but the key should at least be mentioned
in the documentation.
2017-04-19 09:05:03 +02:00
Matthias Clasen bd7fc319c3 docs: Fix a typo
There is no --build-runtime option. It is a build-runtime json
key, and that is obviously what was meant here.
2017-04-19 09:05:03 +02:00
Matthias Clasen 0d2d030bc8 Document flatpak repo command
Add a very short man page for flatpak repo.
2017-04-18 12:36:23 +02:00
Matthias Clasen 77cec62f51 Add a --show-extensions option to flatpak info
This option makes flatpak info list the found extension
that match the given ref.
2017-04-18 12:34:19 +02:00
Matthias Clasen 1d3e3132d7 Add more useful options to flatpak info
The new options are --show-size to show the installed size,
and --show-metadata, to show the metadata file.
2017-04-18 12:34:19 +02:00
Matthias Clasen 581e6f6df5 Drop useless options from flatpak info
The --app and --runtime options are not really useful
for flatpak info, since you need to specify a full ID
anyway, and it is highly unlikely that you will have
ID clashes between apps and runtimes. Also, the options
are documented in a confusing way.
2017-04-18 12:34:19 +02:00
Matthias Clasen c264ac32e3 Add some structure to the generated html
Group things as executables, commands and file formats.
This makes an otherwise too long list more manageable.
2017-04-14 10:48:40 -04:00
Matthias Clasen a57ac7923c Improve html generation
Set some parameters for the docbook style sheets:
- generate links from man page references
- suppress chapter numbering
2017-04-14 10:43:40 -04:00
Matthias Clasen e0d4c655e1 doc: Include all man pages in html
We have a docbook file that generates html versions of
the man pages. Keep it updated.
2017-04-10 06:03:49 -04:00
Matthias Clasen d249698f0f docs: Add a man page for installation files
These files are mentioned in the main flatpak man page,
so we should document their format.
2017-04-10 08:12:37 +02:00
Matthias Clasen 9bec505464 doc: Add a manpage for the repo config format
We support dropping files in this format into /etc/flatpak/remotes.d/,
so we should document the file format.
2017-04-10 08:12:37 +02:00
Matthias Clasen 40fde38232 docs: Add a / to all mentions of installations.d
This is how we indicate other config drop-in directories,
so be consistent about this.
2017-04-10 08:12:37 +02:00
Matthias Clasen ebb1155541 doc: Align build commands with --help
Move build-sign to the same position it has in --help output,
and add build-commit-from to the list of commands.
2017-04-10 08:12:37 +02:00
Matthias Clasen c768d39ea9 docs: Add flatpak make-current to the list of commands
This was missing.
2017-04-10 08:12:37 +02:00
Alexander Larsson fae922584c builder: Add commit property to git source
If branch is unset this is just a nicer way to set a
particular commit. However if both are set, then we verify
that the branch/tag is at that particular commit. This is
a nice way to document that we want to use a particular tag
but still protect against the tag changing or a MITM attack
modifying what that tag means.
2017-04-04 15:21:11 +02:00
Alexander Larsson 3459ef8655 builder: Add disable-fsckobjects to git sources
This lets you work around clone problems for broken
git repositories.

Fixes https://github.com/flatpak/flatpak/issues/661
2017-04-04 14:31:48 +02:00
Matthias Clasen a749602aee Split the manifest file docs off
Instead of one mega flatpak-builder man page, move the
file format documnentation to its own man page in the
right section, and shorten the flatpak-builder one.
2017-03-30 09:15:05 +02:00
Mario Sanchez Prada 38a1eeea0e Add new API to the docs
Some of this API has been added a while ago, but never
made it to the sections file, so add it now.
2017-03-27 14:11:43 +02:00
Matthias Clasen e0067ef2d0 document more metadata keys
A bunch of keys got added in code recently, and the
flatpak-metadata(5) man page has not been kept up-to-date.
2017-03-27 08:59:06 +02:00
Alexander Larsson 81c444892a builder: Make cflags, cxxflags and ldflags append, not replace
This is much more natural, and means you don't have to duplicate the
flags in each place.
2017-03-14 10:53:38 +01:00
Alexander Larsson 0f0188aacb builder: Add support for ldflags 2017-03-14 10:26:22 +01:00
Alexander Larsson 49b5304589 Update OCI support to latest version of spec
This is a major change in the OCI support, as the format of the OCI image
registries changed. Instead of now having a "ref" file for each image
in the repo it has a single index json file, where the ref name is now
a per-image annotation.

This allows us to support OCI much better, as we can now use the actual
flatpak ref as the OCI ref name, and we can find all the flatpak refs
in a remote.

So, with this you can just use:
 flatpak remote-add --oci remote-name URL

and then you can use the regular flatpak operations on the remote.
2017-03-13 14:31:36 +01:00
Matthew Leeds 66f0efda41 doc: Add docs for undocumented options
A few options aren't documented in the manpages. This commit adds
documentation for them based on the --help output and relevant commit
messages. Some of it could probably use more elaboration.
2017-03-07 21:19:02 +01:00
Matthew Leeds 2d07f7d455 doc: Make manpages consistent with --help output
For a few commands the options aren't fully documented. This commit
makes the manpage documentation (almost) match the options shown
when you run "<command> --help" on the command line.
2017-03-07 21:19:02 +01:00
Matthew Leeds d9272ab120 doc: Fix typos 2017-03-07 21:19:02 +01:00
Matthew Leeds 4817421289 doc: Fix example for flatpak-info command 2017-03-07 21:19:02 +01:00
Matthias Clasen cb95375efd Merge pull request #593 from mwleeds/update-run-docs
doc: Mention that flatpak-run can be used with runtimes
2017-03-01 10:30:55 -05:00
Alexander Larsson 27b4b3906a build-finish: Add --metadata= support
This lets us set generic metadata keys
2017-02-28 17:50:32 +01:00
Alexander Larsson 44399bcf5f builder: Add only-arches and skip-arches for sources 2017-02-28 17:41:45 +01:00
Alexander Larsson 0379c01981 builder: Add build-arches and skip-arches to modules
This lets you avoid modules on some arches.
2017-02-28 12:07:53 +01:00
Alexander Larsson c3322fd9e9 builder: Add no-make-install to modules
This is useful for modules that don't have a make install rule.
You can use the new build-commands which is run after make to
create your own custom installation phase.

Fixes https://github.com/flatpak/flatpak/issues/458
2017-02-28 11:30:59 +01:00
Matthew Leeds 6d0f86d868 doc: Mention that flatpak-run can be used with runtimes
The ability to use flatpak-run to enter into a shell in a runtime was
added in flatpak 0.6.13 but the docs weren't updated to reflect that.
This commit updates the flatpak-run documentation to explain the
functionality.
2017-02-27 15:04:37 -06:00
Matthias Clasen a95dbc8e9b Document --from-git and --from-git-branch 2017-02-23 17:15:35 +01:00
Alexander Larsson 364499939d builder: Add --skip-if-unchanged
This lets you skip rebuilds unless the actual json changes.
This is useful for continuos builds that only run if the json
changes, not on any commit to any git source.
2017-02-22 15:12:59 +01:00
Alexander Larsson 61db31bb00 builder: Add ensure-writable to module 2017-02-22 09:48:00 +01:00