Commit Graph

586 Commits

Author SHA1 Message Date
Rafael Fontenelle
95e692794b Fix misspellings
Closes: #2807
Approved by: matthiasclasen
2019-04-08 12:50:42 +00:00
Matthew Leeds
d3b7bfa92d doc: Fix capitalization of gedit
It's gedit not GEdit[1][2].

[1] https://wiki.gnome.org/Apps/Gedit
[2] https://flathub.org/apps/details/org.gnome.gedit

Closes: #2788
Approved by: matthiasclasen
2019-03-30 13:02:10 +00:00
Matthew Leeds
12d5ee74f3 doc/flatpakref: Fix description of Name key
The Name key specifies the ID of the app or runtime, not the ID of the
app's runtime.

Closes: #2760
Approved by: matthiasclasen
2019-03-15 18:16:54 +00:00
Alexander Larsson
d0026af959 build-update-repo: Add --static-delta-ignore-ref=PATTERN
This is useful if you don't want to e.g. generate deltas for debug
or source refs.
2019-03-12 14:53:36 +01:00
Matthew Leeds
cdb3407c59 doc/flatpak-install: Tweak examples
The gnome-apps repo is not being kept up to date so we don't want to
imply that people should use it, and make a few other tweaks to the
install command examples.

Closes: #2743
Approved by: matthiasclasen
2019-03-07 14:38:38 +00:00
Alexander Larsson
441c1f52ea build-commit-from: Support --extra-collection-id
If this is passed, we add an extra collection id binding to
the commit, as well as create a separate ref for that particular
collection id.

This weakly depends on:
  https://github.com/ostreedev/ostree/pull/1805
In that without that change ostree pull will not respect
multiple collection-id bindings. It will still work for
the main/first collection id though.

Closes: #2634
Approved by: alexlarsson
2019-01-28 08:37:51 +00:00
Matthias Clasen
7ec898f00b Document --columns ellipsization
Update the relevant man pages with this information.

Closes: #2624
Approved by: matthiasclasen
2019-01-23 12:45:00 +00:00
Matthew Leeds
c6d511268a doc/flatpak-metadata: Link to fd.o spec consistently
Avoid linking to the same fd.o spec just linked to a few lines above,
and rearrange things to be more readable.

Closes: #2606
Approved by: matthiasclasen
2019-01-17 02:25:10 +00:00
Matthias Clasen
81b25058ae docs: Clarify that --command is only for run
This may not otherwise be obvious.

Closes: #2592
Approved by: matthiasclasen
2019-01-15 20:17:31 +00:00
Matthias Clasen
71411ee88c repair: Document --reinstall-all
Closes: #2473
Approved by: alexlarsson
2019-01-14 13:21:12 +00:00
Matthias Clasen
b293562ae9 repair: Document --dry-run
Also mention the need to run flatpak repair as root
when operating on system repositories.

Closes: #2473
Approved by: alexlarsson
2019-01-14 13:21:12 +00:00
Matthias Clasen
042c1f7174 list: Fix a typo in the docs
Its --columns, not --column.

Closes: #2568
2019-01-13 11:15:18 -05:00
Matthias Clasen
4ff95d94e8 build-export: Document that NOW is a valid timestamp
We may not want to guarantee all the formats that this
datetime parser accepts, but NOW seems useful enough and
is already mentioned in flatpak-build-commit-from(1).

Closes: #2498
Approved by: matthiasclasen
2019-01-11 18:32:44 +00:00
Matthias Clasen
a35030ab5e build-commit-from: Document missing options
Document --end-of-life, --timestamp and --disable-fsync.

Closes: #2498
Approved by: matthiasclasen
2019-01-11 18:32:44 +00:00
Matthias Clasen
51a7643d41 Document the new options
Closes: #2556
Approved by: alexlarsson
2019-01-11 11:42:13 +00:00
Matthias Clasen
497b784d21 doc: Add a missing comma
Fix a pervasively copied typo.

Closes: #2553
Approved by: matthiasclasen
2019-01-09 18:45:38 +00:00
Matthias Clasen
4f915388a5 Document --installations
Closes: #2122
Approved by: matthiasclasen
2019-01-08 00:26:17 +00:00
Matthias Clasen
4fad2de113 Generate a single-file api reference
Add a rule to generate a single-file html version of the
libflatpak api reference, for integration into readthedocs.

This is pretty plain, but serves the purpose.

Closes: #2526
Approved by: matthiasclasen
2019-01-07 22:56:43 +00:00
Matthias Clasen
efcf48f295 Rename library docs main xml file
We already have a flatpak-docs.xml file one level up.
This can only lead to confusion.

Closes: #2526
Approved by: matthiasclasen
2019-01-07 22:56:43 +00:00
Matthias Clasen
7c79fcc197 build-export: Document --end-of-life
This option was added without documentation.

Closes: #2524
Approved by: mwleeds
2019-01-04 19:25:32 +00:00
Matthew Leeds
5238dd4f4b doc: Update wording for verbose options
This more closely matches the recently changed --help output for these
options, and distinguishes them from the options that only print some
information and exit.

Closes: #2537
Approved by: matthiasclasen
2019-01-04 03:53:19 +00:00
Matthias Clasen
5bb7d9aec6 docs: Small improvements
Make it clear that flatpak(1) only lists global options,
and individual commands have their own.

Add a reference to flatpak-installation(5)

Closes: #2513
Approved by: mwleeds
2019-01-03 22:38:55 +00:00
Matthias Clasen
1ab6bb027a build-bundle: Document --from-commit
This option was missing from the docs.

Closes: #2528
Approved by: mwleeds
2019-01-03 22:22:48 +00:00
Matthias Clasen
f453544aaa Document the --cwd option
Closes: #2443
Approved by: alexlarsson
2018-12-20 15:35:23 +00:00
Matthias Clasen
1f64886c6e remote-ls: Update the docs
Add the new columns, and match column order
with --help output.

Closes: #2409
Approved by: alexlarsson
2018-12-19 15:45:34 +00:00
Matthias Clasen
f53ad59ccf list: Update the docs
Add new columns, and update the example.

Closes: #2409
Approved by: alexlarsson
2018-12-19 15:45:34 +00:00
Matthias Clasen
cca8355b72 search: Update the docs
Document the --columns option as we do everywhere.

Closes: #2409
Approved by: alexlarsson
2018-12-19 15:45:34 +00:00
Matthias Clasen
1bab520197 Document FLATPAK_ID
Mention this environment variable in flatpak-run(1).

Closes: #2447
Approved by: alexlarsson
2018-12-19 14:35:39 +00:00
Matthias Clasen
dc5a451389 Add docs for flatpak-spawn
Add a flatpak-spawn(1) man page. While it is not ideal
to have the docs live separately from the code, having
it here ensures that it will be available everywhere
all the other flatpak documentation is.

Closes: #2437
Approved by: alexlarsson
2018-12-17 08:29:52 +00:00
Matthias Clasen
07a0fd2811 Document the new env vars
Closes: #2440
Approved by: alexlarsson
2018-12-17 08:14:43 +00:00
Matthias Clasen
df5b705941 Merge pull request #2419 from matthiasclasen/env-docs
doc: Mention xdg vars
2018-12-12 16:15:41 -05:00
Alexander Larsson
90dad12697 build-update-repo: Add --static-delta-jobs option
We ran into some issues on flathub where a build with very large
files caused the parallel delta generation to use a lot of paging,
essentially blocking progress. This option can at least allow you
to make progress in that case, although we should ideally have
a better solution.

Closes: #2416
Approved by: alexlarsson
2018-12-12 16:15:16 +00:00
Matthew Leeds
aa19b18ee0 fixup! doc: Mention xdg vars 2018-12-11 21:32:00 -08:00
Matthias Clasen
f3748affc4 doc: Mention xdg vars
When I made the list of overridden environment variables,
I forgot the 3 most important ones, XDG_{DATA,CACHE,CONFIG}_HOME.
2018-12-11 23:36:19 -05:00
Matthias Clasen
d613bc0532 Minor revisions of flatpak(1)
Capitalize Flatpak in text, add a paragraph about building
that references flatpak-builder, and add a reference to
www.flatpak.org.

Closes: #2410
Approved by: alexlarsson
2018-12-10 07:15:12 +00:00
Matthew Leeds
0cac27fd87 doc/flatpak-uninstall: Fix leftover xdg-app typo 2018-12-04 23:26:34 -08:00
Matthias Clasen
754d68c74a Rename list commands
Rename permission-list and document-list to
permissions and documents, for consistency with
how we handle remotes. The old command names
are kept as hidden aliases.

Closes: #2131

Closes: #2366
Approved by: mwleeds
2018-12-03 19:46:09 +00:00
Matthias Clasen
676b2943cf Improve flatpak-config docs
Include a list of keys.

Closes: #2360

Closes: #2364
Approved by: mwleeds
2018-12-01 01:53:53 +00:00
Matthew Leeds
5266600b5f doc/flatpak-config: Improve synopsis
Make it clear that the command can be used a few different ways, and the
option used determines the needed positional arguments.

Closes: #2361
Approved by: matthiasclasen
2018-12-01 00:04:38 +00:00
Matthew Leeds
6111b81bb6 doc/flatpak-config: Fix example command
The key is "languages" not "language", and the value needs to be quoted.

Closes: #2361
Approved by: matthiasclasen
2018-12-01 00:04:38 +00:00
Patrick Griffis
5bbdb0628e doc: Update download-if/enable-if docs
Closes: #1436
Approved by: matthiasclasen
2018-11-17 23:42:49 +00:00
Matthew Leeds
5fe2a0aabe uninstall: Add support for fuzzy matching
This adds support for fuzzy matching ref names (AKA "typo helper") to
the uninstall command to mirror what the install command has. In short,
this means you can do "flatpak uninstall gedit" instead of "flatpak
uninstall org.gnome.gedit". Flatpak will prompt you to choose between
similarly named installed refs, and will only make the choice for you if
--assumeyes was used and there's only one match.

Note that this commit does have the side effect that if there are
multiple matching refs with the same ID (e.g. with different branches or
in different installations) you are prompted to choose between them.
Previously you were shown an error message.

Closes: #2330
Approved by: matthiasclasen
2018-11-17 13:00:33 +00:00
Matthew Leeds
348fcc3f97 Add a DeployCollectionID key to replace CollectionID
This commit adds a key called DeployCollectionID to the flatpakref and
flatpakrepo file formats, which is intended to replace the CollectionID
key (which is still supported but deprecated). The reason for the change
is the same as for the metadata key change from xa.collection-id to
ostree.deploy-collection-id, which is that old versions of Flatpak
(roughly 0.9.8 through 1.0.1 depending on compile time options) hit
various bugs when collection IDs are in use. Flathub will soon enable
the metadata key to deploy collection IDs, and this change means Flathub
can also deploy the collection ID in flatpakref and flatpakrepo files
without affecting old clients.

Adding DeployCollectionID to the flatpakref and flatpakrepo files will
mean the flathub remote can be automatically configured with a
collection ID without depending on the metadata key to do that.

Closes: #2329
Approved by: alexlarsson
2018-11-16 09:17:07 +00:00
Matthew Leeds
eda5dee589 doc/flatpakref: Fix a typo 2018-11-15 15:35:47 -08:00
Matthew Leeds
af8da20426 doc: Fix a mistake in the RuntimeRepo docs 2018-11-15 14:07:24 -08:00
Matthias Clasen
9e6287aa0e Document the --delete-data option
Useful functionality should be documented.

Closes: #2314
Approved by: matthiasclasen
2018-11-14 17:15:42 +00:00
Matthias Clasen
fc77535212 Remove a wrong statement from uninstall docs
We do not have code to remove the apps data directory.

Closes: #2309

Closes: #2312
Approved by: matthiasclasen
2018-11-13 14:12:28 +00:00
Matthias Clasen
bf7af547aa Small fixes to many man pages
Make synopses more concise in various place, improve
consistency of formatting, and fix some small mistakes
and oversights.

Closes: #2307
Approved by: matthiasclasen
2018-11-12 14:28:41 +00:00
Umang Jain
94969d5057 Installation: Add flatpak_installation_get_min_free_space_bytes
A convenience wrapper around ostree_repo_get_min_free_space_bytes().
Clients programs like gnome-software can get the value of minimum free
space as defined in the OSTree repo. This can be useful in various
disk-space checks these client program can implement.

At Endless, we have downstream heuristics in gnome-software which
determine the success/failure likelihood of an install/update
operation to some extend. Depending upon the likelihood of the
success/failure we dispatch install/update/auto-update operations.

With client programs gaining features such as auto-updates, it makes
sense to have a min-free-space API so that these programs can check
free-space availablity vs minimum free space defined by user inside
OSTree's repo before auto-updating. Although, OSTree will certainly
fail operations over-stepping min-free-space's value; It's just a
matter of convenience to provide a way to query the value to client
programs as well.

Closes: #2274
Approved by: matthiasclasen
2018-11-07 12:02:14 +00:00
Matthew Leeds
27a611d4eb doc/flatpak-install: Make arg name consistent throughout
Closes: #2113
Approved by: matthiasclasen
2018-10-31 22:48:56 +00:00