Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: rename man pages to flatpakref(5) and flatpakrepo(5) #5664

Merged
merged 1 commit into from
Feb 15, 2024
Merged

doc: rename man pages to flatpakref(5) and flatpakrepo(5) #5664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
doc: rename man pages to flatpakref(5) and flatpakrepo(5) 
Add symlinks to preserve flatpak-prefixed names.

Also fix section reference in flatpak-install(1).
  • Loading branch information
@chrisawi @smcv
chrisawi authored and smcv committed Feb 15, 2024
commit d285e19dc252795d2d1f8faf340250769c3267f4
8 changes: 6 additions & 2 deletions doc/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ man1 = \

man5 = \
flatpak-metadata.5 \
flatpak-flatpakrepo.5 \
flatpak-flatpakref.5 \
flatpakrepo.5 \
flatpakref.5 \
flatpak-remote.5 \
flatpak-installation.5 \
$(NULL)
Expand Down Expand Up @@ -97,6 +97,10 @@ DISTCLEANFILES = \
flatpak-docs.xml \
$(NULL)

install-data-hook:
ln -sf flatpakrepo.5 $(DESTDIR)$(mandir)/man5/flatpak-flatpakrepo.5
ln -sf flatpakref.5 $(DESTDIR)$(mandir)/man5/flatpak-flatpakref.5

if DOCBOOK_DOCS_ENABLED

doc_DATA = \
Expand Down
4 changes: 2 additions & 2 deletions doc/flatpak-docs.xml.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@
</chapter>
<chapter>
<title>File Formats</title>
<xi:include href="@srcdir@/flatpak-flatpakrepo.xml"/>
<xi:include href="@srcdir@/flatpak-flatpakref.xml"/>
<xi:include href="@srcdir@/flatpakrepo.xml"/>
<xi:include href="@srcdir@/flatpakref.xml"/>
<xi:include href="@srcdir@/flatpak-installation.xml"/>
<xi:include href="@srcdir@/flatpak-metadata.xml"/>
<xi:include href="@srcdir@/flatpak-remote.xml"/>
Expand Down
2 changes: 1 addition & 1 deletion doc/flatpak-install.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@
<citerefentry><refentrytitle>flatpak-update</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-list</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-build-bundle</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-flatpakref</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-make-current</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ostree-find-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
Expand Down
2 changes: 1 addition & 1 deletion doc/flatpak-remote-add.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ allow org.signal.Signal.*/*/stable
<citerefentry><refentrytitle>flatpak-remote-modify</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remote-delete</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remotes</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
<citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>

Expand Down
2 changes: 1 addition & 1 deletion doc/flatpak-remote.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

<para>
System-wide remotes can be statically preconfigured by dropping
<citerefentry><refentrytitle>flatpak-flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry> files into <filename>/etc/flatpak/remotes.d/</filename>.
<citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry> files into <filename>/etc/flatpak/remotes.d/</filename>.
</para>

</refsect1>
Expand Down
6 changes: 3 additions & 3 deletions doc/flatpak.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@

<para>
System-wide remotes can be statically preconfigured by dropping
<citerefentry><refentrytitle>flatpak-flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry> files into <filename>/etc/flatpak/remotes.d/</filename>.
<citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry> files into <filename>/etc/flatpak/remotes.d/</filename>.
</para>

<para>
Expand Down Expand Up @@ -559,14 +559,14 @@

<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>

<listitem><para>
Reference to a remote for an application or runtime
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>flatpak-flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>
<term><citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry></term>

<listitem><para>
Reference to a remote
Expand Down
6 changes: 3 additions & 3 deletions doc/flatpak-flatpakref.xml → doc/flatpakref.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<refentry id="flatpak-flatpakref">
<refentry id="flatpakref">

<refentryinfo>
<title>flatpakref</title>
Expand All @@ -24,7 +24,7 @@
</refmeta>

<refnamediv>
<refname>flatpak-flatpakref</refname>
<refname>flatpakref</refname>
<refpurpose>Reference to a remote for an application or runtime</refpurpose>
</refnamediv>

Expand Down Expand Up @@ -169,7 +169,7 @@ DeployCollectionID=org.gnome.Apps
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-install</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>flatpak-flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpakrepo</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
</para>

</refsect1>
Expand Down
6 changes: 3 additions & 3 deletions doc/flatpak-flatpakrepo.xml → doc/flatpakrepo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http:https://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">

<refentry id="flatpak-flatpakrepo">
<refentry id="flatpakrepo">

<refentryinfo>
<title>flatpakrepo</title>
Expand All @@ -24,7 +24,7 @@
</refmeta>

<refnamediv>
<refname>flatpak-flatpakrepo</refname>
<refname>flatpakrepo</refname>
<refpurpose>Reference to a remote</refpurpose>
</refnamediv>

Expand Down Expand Up @@ -167,7 +167,7 @@ DeployCollectionID=org.gnome.Apps
<para>
<citerefentry><refentrytitle>flatpak</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-remote-add</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>flatpak-flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry>
<citerefentry><refentrytitle>flatpakref</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>

</refsect1>
Expand Down
26 changes: 24 additions & 2 deletions doc/meson.build
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,17 @@ man1 = [

man5 = [
'flatpak-metadata',
'flatpak-flatpakrepo',
'flatpak-flatpakref',
'flatpakrepo',
'flatpakref',
'flatpak-remote',
'flatpak-installation',
]

man_compat_symlinks = [
['flatpak-flatpakrepo', 'flatpakrepo', '5'],
['flatpak-flatpakref', 'flatpakref', '5'],
]

xml_files = []

foreach pair : [[man1, '1'], [man5, '5']]
Expand Down Expand Up @@ -99,6 +104,23 @@ foreach pair : [[man1, '1'], [man5, '5']]
endforeach
endforeach

foreach entry : man_compat_symlinks
name = entry[0]
target = entry[1]
section = entry[2]

if build_man_pages
#TODO: replace with install_symlink() when we can depend on meson 0.61
meson.add_install_script(
'sh', '-c', 'ln -sf @0@ $MESON_INSTALL_DESTDIR_PREFIX/@1@/@2@'.format(
target + '.' + section,
get_option('mandir') / ('man' + section),
name + '.' + section
)
)
endif
endforeach

if xmlto.found()
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
Expand Down