Commit Graph

498 Commits

Author SHA1 Message Date
Matthew Leeds
76a5c63c19 doc/flatpak-build-bundle.xml: Add a usage example
In the output of `flatpak build-bundle --help` it's not clear what
LOCATION is, so the least we can do is add an example of its usage to
the man page. At some point it would be nice to also have explanations
of positional arguments in help output.

Closes: #1974
Approved by: alexlarsson
2018-08-17 08:24:33 +00:00
Owen W. Taylor
d7d05a8619 Use oci+http[s]:// as an URL to identify OCI registries
The old pattern of using a separate 'OCI' flag was very ugly
internally in the code once it was extended to flatpak bundles and
flatpakrefs - using a different URI scheme means that the nature
of the remote can't be accidentally lost in some part of the code.

Probing would be possible as well, but would make it difficult to
add a remote when offline, and also doesn't deal well with the
fact that our data layout is different for the two types of remotes -
the type of remote could change at any point!

As a side effect this change enables flatpakrefs and flatpak bundles for OCI
registries.
2018-08-13 11:23:28 +02:00
Alexander Larsson
f176d3eba3 Add --disable-fsync to build-export and build-commit-from
This mirrors ostree commit --disable-fsync and is useful in some cases.
For instance, we'd like to use it when building the temporary import
repositories in flathub.

Closes: #1951
Approved by: alexlarsson
2018-08-09 13:12:42 +00:00
Matthew Leeds
1e75e645f1 create-usb: Automatically update the repo summary
Copying refs from the system repo into a repo on a USB drive requires
the summary in the system repo to be up to date (and similarly for other
flatpak installations like a per-user one). At the moment we expect the
user to run `sudo ostree summary -u` before `flatpak create-usb` which
is a bad user experience. Another option is to set
`core.auto-update-summary` to true on the ostree repo config, but there
are significant performance concerns with that: it involves updating the
summary after every transaction rather than only when we need it. So
this commit changes the create-usb command to use the "UpdateSummary"
system-helper method to update the summary in the source repo before
copying to the destination. This strategy allows us to continue to let
non-root users use `flatpak create-usb`. This commit also tries to
update the remote repo metadata and appstream data for each remote
before copying to the USB, because we can now do that without
invalidating the summary.

Closes: #1945
Approved by: alexlarsson
2018-08-08 14:42:16 +00:00
Alexander Larsson
2d3f493f27 run: Add --die-with-parent to run
This is similare to the already existing arg in flatpak build.

Closes: #1946
Approved by: alexlarsson
2018-08-08 12:09:14 +00:00
Matthias Clasen
e03c61ebbc Add file format docs to flatpak.1
The flatpak.1 man page serves as an overview page that lists
all the individual command man pages. Make it a complete
overview by listing the file format man pages as well.

Closes: #1944
Approved by: alexlarsson
2018-08-07 09:30:30 +00:00
Matthias Clasen
97f2e3a3fa Merge pull request #1929 from flatpak/autoprune-unless-docs
doc: Document the autoprune-unless metadata key
2018-07-27 18:54:19 -04:00
Matthew Leeds
59997dd126 doc: Document the autoprune-unless metadata key 2018-07-27 12:47:08 -07:00
P. F. Chimento
fbd84d93e4 manpage: Refer to flatpak-metadata documentation
The documentation for extension info can be found there.

See #1341.

Closes: #1927
Approved by: mwleeds
2018-07-27 19:27:19 +00:00
Matthew Leeds
425385d3ea fixup! doc: Add a man page for the repair command 2018-07-17 12:20:44 -07:00
Matthew Leeds
af10bb98ec doc: Add a man page for the repair command
Add a man page based on one of the comments in
app/flatpak-builtins-repair.c

Fixes https://github.com/flatpak/flatpak/issues/1820
2018-07-16 17:43:12 -07:00
朝歌
d7b9d3fc2b Update flatpak-document-unexport.xml
Closes: #1896
Approved by: mwleeds
2018-07-12 11:41:52 +00:00
Matthew Leeds
8aaacaac50 doc: Fix another typo 2018-07-11 17:58:13 +02:00
Matthew Leeds
6a49f65b6a doc: Fix a typo 2018-07-11 17:54:52 +02:00
Matthew Leeds
7decfe39ae doc: Fix my typos 2018-07-10 19:30:58 +02:00
Matthew Leeds
c9a9b3a1ee doc: Mention P2P capabilities of install/update
Fixes https://github.com/flatpak/flatpak/issues/1329
2018-07-10 19:26:06 +02:00
Alexander Larsson
adffe7d15f fixup! Add flatpak_transaction_operation_type_to_string() 2018-07-10 19:25:44 +02:00
Matthew Leeds
b35144a691 create-usb: Avoid invalidating the summary file
Since the create-usb command doesn't run as root (and if it did GNOME
Software wouldn't be able to call out to it), it can't update the
summary file in the source repo if the system installation is being
used. So the user is expected to run `ostree summary -u` before using
create-usb. But if the create-usb command then updates the appstream
data and repo metadata refs, the summary will no longer point to the
latest commits on those refs. As a short term fix, avoid updating the
appstream data and repo metadata, and mention in the manpage that the
user should do so. The better solution, not requiring any manual steps
on the user's part, will require a fix for
https://github.com/ostreedev/ostree/issues/1664.
2018-07-10 19:25:39 +02:00
Matthew Leeds
f16caf23af doc: Fix typos 2018-07-10 17:54:39 +02:00
Matthew Leeds
905d7ca096 doc: Fix grammar 2018-07-10 17:44:39 +02:00
Alexander Larsson
c0ebd3a121 transaction: Move flatpakref installation to transaction code
This adds the flatpak_transaction_add_install_flatpakref method
to easily install from flatpakref files. It additionally
adds a new signal called add-new-remote which is called in two
cases:

 To ask if the user wants to add a "normal" remote for the url
 specified by a flatpakref file.

 When a new remote is required for the runtimes the application
 depends on.

Closes: #1868
Approved by: alexlarsson
2018-07-07 15:38:46 +00:00
Alexander Larsson
1ecca029a8 transaction: Add flatpak_transaction_set_default_arch
This will be used as the default when installing something that
doesn't specify a ref, such as a flatpakref file.

Closes: #1868
Approved by: alexlarsson
2018-07-07 15:38:46 +00:00
Matthew Leeds
e959fd3db0 WIP: Add a create-usb command
Fixes https://github.com/flatpak/flatpak/issues/1672

Closes: #1828
Approved by: alexlarsson
2018-07-07 15:25:50 +00:00
Matthew Leeds
1a79b46059 doc: Point to the source of the generated HTML
When you're looking at the Flatpak Command Reference on
docs.flatpak.org, it's not clear that it was generated from the flatpak
repo. So add a notice to the docbook that's used to generate the HTML.
This was pointed out by
https://github.com/flatpak/flatpak-docs/pull/134
2018-07-07 17:17:03 +02:00
Matthew Leeds
ed4dba55a3 doc/flatpak.xml: Add permission-* commands 2018-06-29 10:25:56 -07:00
Matthew Leeds
2f287cec4e doc: Fix minor mistakes 2018-06-29 07:14:11 -07:00
Alexander Larsson
93ca5cdf45 transaction: Add get_installation()
Closes: #1841
Approved by: alexlarsson
2018-06-29 12:56:15 +00:00
Matthias Clasen
4c0662b03a Add a permission-reset command
This command removes all permissions for a given app
from the permission store.

Closes: #1837
Approved by: alexlarsson
2018-06-29 11:52:40 +00:00
Matthias Clasen
e9f5b1cf06 Add a permission-show command
This shows all the entries pertaining to a particular
app from the permission store.

Closes: #1837
Approved by: alexlarsson
2018-06-29 11:52:40 +00:00
Matthias Clasen
9867bb0cf5 Add a permission-remove command
This removes an item from the permission store.

Closes: #1837
Approved by: alexlarsson
2018-06-29 11:52:40 +00:00
Matthias Clasen
5d9bbeaed2 Add a permission-list command
This command dumps the content of the permission store
database(s).

Closes: #1837
Approved by: alexlarsson
2018-06-29 11:52:40 +00:00
Matthew Leeds
d5606cd43a doc: Fix documentation of shared options
The --verbose and --ostree-verbose options are global to all
subcommands, but --version can only be used with the main "flatpak"
command, so fix the man pages to reflect that.
2018-06-26 00:10:55 -07:00
Matthew Leeds
3ac2672d5d doc: Minor fixes
The positional argument for the uninstall command is now called REF
rather than NAME, so update the docs to reflect that, and fix a typo in
the flatpak-list man page.
2018-06-25 23:14:25 -07:00
Matthew Leeds
0c27279895 doc: Add missing commands to flatpak(1) 2018-06-25 22:02:06 -07:00
Matthew Leeds
012e47cb7d doc: Uncomment and tweak P2P docs
Now that P2P support is enabled unconditionally, uncomment the
P2P-related parts of the man pages.

Closes: #1803
Approved by: alexlarsson
2018-06-20 08:05:02 +00:00
Alexander Larsson
23f1df8a5b Transaction: Add operation getters for metadata and old_metadata
Closes: #1799
Approved by: alexlarsson
2018-06-19 14:54:22 +00:00
Alexander Larsson
1e7e6376ff gtk-doc: Add all missing symbols to flatpak.sections
Closes: #1797
Approved by: alexlarsson
2018-06-19 08:30:21 +00:00
Joonas Sarajärvi
59ecad0f29 Add ssh-auth socket support
SSH authentication sockets can be placed in a number of places, so it
is difficult for applications to just mount a fixed directory or
directories, hoping that SSH_AUTH_SOCK points somewhere inside the
mounted content.

Closes: #1764
Approved by: alexlarsson
2018-06-19 07:11:36 +00:00
Will Thompson
cd87b542ba doc/flatpak-info: update machine-readable output list
I generated this list mechanically from the big if () condition in
flatpak-builtins-info.c, which is why they're one per line, and I think
it's more maintainable in this layout. (Whitespace has no effect on the
HTML or manpage output.)

Closes: #1788
Approved by: alexlarsson
2018-06-19 07:02:15 +00:00
Will Thompson
4fdefefb06 doc/flatpak-info: add missing options
Compared to `flatpak info --help` (which is what actually counts), 6
options were not documented, and one (--version) was documented but
doesn't exist.

Closes: #1788
Approved by: alexlarsson
2018-06-19 07:02:15 +00:00
Matthew Leeds
2df6916505 Fix a few mistakes in the docs 2018-06-15 12:31:40 -07:00
Alexander Larsson
cefe0a2e41 uninstall: Add --unused
This removes all runtimes that are not used by some app, or any sdk
used by a runtime that some app uses.

Closes: #1754
Approved by: alexlarsson
2018-06-04 12:08:59 +00:00
Alexander Larsson
8df5a6af11 Fix up gtk-doc warnings 2018-05-29 16:49:44 +02:00
Alexander Larsson
9672782694 libflatpak: Update docs for library 2018-05-29 16:37:21 +02:00
Alexander Larsson
11908f4fa3 docs: Add revert example to build-commit-from manpage
Closes: #1725
Approved by: alexlarsson
2018-05-29 07:53:55 +00:00
Alexander Larsson
b16ae4cc18 gtk-doc: Fix up -I from move from lib/ to common/
Closes: #1729
Approved by: alexlarsson
2018-05-29 07:53:48 +00:00
Alexander Larsson
7739209a74 context: Add --allow=bluetooth
This gives access to AF_BLUETOOTH sockets in the seccomp rules. You additionally
need to give network access for the sockets to really work, because the
kernel doesn't (yet) namespace bluetooth sockets.

Closes: #1721
Approved by: alexlarsson
2018-05-28 13:06:50 +00:00
Alexander Larsson
9cd5a04bb3 Fix dist for docs 2018-05-25 17:05:44 +02:00
Mario Sanchez Prada
3ee19d609d lib/installation: Adding missing documentation for the newly added API
Add FLATPAK_UPDATE_FLAGS_NO_PRUNE and flatpak_installation_uninstall_full()
to the documentation, along with a couple of small fixes.

https://github.com/flatpak/flatpak/issues/1703

Closes: #1705
Approved by: pwithnall
2018-05-23 16:55:13 +00:00
Matthew Leeds
4d5a93db04 doc: Fix a typo 2018-05-03 16:59:04 -07:00