From c3834f9b881f2b1a68dc7d797c134f0b66b47b57 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 6 Mar 2014 18:26:06 +0100 Subject: [PATCH] generators: add Documentation= fields that point to the generator man pages --- src/cryptsetup/cryptsetup-generator.c | 2 +- src/dbus1-generator/dbus1-generator.c | 6 ++++-- src/efi-boot-generator/efi-boot-generator.c | 3 ++- src/fstab-generator/fstab-generator.c | 15 +++++++++------ src/gpt-auto-generator/gpt-auto-generator.c | 8 +++++--- 5 files changed, 21 insertions(+), 13 deletions(-) diff --git a/src/cryptsetup/cryptsetup-generator.c b/src/cryptsetup/cryptsetup-generator.c index 9460e83fd..75d56ddaf 100644 --- a/src/cryptsetup/cryptsetup-generator.c +++ b/src/cryptsetup/cryptsetup-generator.c @@ -121,7 +121,7 @@ static int create_disk( "# Automatically generated by systemd-cryptsetup-generator\n\n" "[Unit]\n" "Description=Cryptography Setup for %I\n" - "Documentation=man:systemd-cryptsetup@.service(8) man:crypttab(5)\n" + "Documentation=man:crypttab(5) man:systemd-cryptsetup-generator(8) man:systemd-cryptsetup@.service(8)\n" "SourcePath=/etc/crypttab\n" "DefaultDependencies=no\n" "Conflicts=umount.target\n" diff --git a/src/dbus1-generator/dbus1-generator.c b/src/dbus1-generator/dbus1-generator.c index b1c94c235..a7b36d18e 100644 --- a/src/dbus1-generator/dbus1-generator.c +++ b/src/dbus1-generator/dbus1-generator.c @@ -66,7 +66,8 @@ static int create_dbus_files( "# Automatically generated by systemd-dbus1-generator\n\n" "[Unit]\n" "SourcePath=%s\n" - "Description=DBUS1: %s\n\n" + "Description=DBUS1: %s\n" + "Documentation=man:systemd-dbus1-generator(8)\n\n" "[Service]\n" "ExecStart=%s\n" "Type=dbus\n" @@ -122,7 +123,8 @@ static int create_dbus_files( "# Automatically generated by systemd-dbus1-generator\n\n" "[Unit]\n" "SourcePath=%s\n" - "Description=DBUS1: %s\n\n" + "Description=DBUS1: %s\n" + "Documentation=man:systemd-dbus1-generator(8)\n\n" "[BusName]\n" "Name=%s\n" "Service=%s\n", diff --git a/src/efi-boot-generator/efi-boot-generator.c b/src/efi-boot-generator/efi-boot-generator.c index 270dc226e..cf9ff73b1 100644 --- a/src/efi-boot-generator/efi-boot-generator.c +++ b/src/efi-boot-generator/efi-boot-generator.c @@ -100,7 +100,8 @@ int main(int argc, char *argv[]) { fprintf(f, "# Automatially generated by systemd-efi-boot-generator\n\n" "[Unit]\n" - "Description=EFI System Partition\n"); + "Description=EFI System Partition\n" + "Documentation=man:systemd-efi-boot-generator(8)\n"); r = generator_write_fsck_deps(f, arg_dest, what, "/boot", "vfat"); if (r < 0) diff --git a/src/fstab-generator/fstab-generator.c b/src/fstab-generator/fstab-generator.c index c50586b79..248a4ceb9 100644 --- a/src/fstab-generator/fstab-generator.c +++ b/src/fstab-generator/fstab-generator.c @@ -101,7 +101,8 @@ static int add_swap(const char *what, struct mntent *me) { fprintf(f, "# Automatically generated by systemd-fstab-generator\n\n" "[Unit]\n" - "SourcePath=/etc/fstab\n\n" + "SourcePath=/etc/fstab\n" + "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n\n" "[Swap]\n" "What=%s\n", what); @@ -208,10 +209,11 @@ static int add_mount( } fprintf(f, - "# Automatically generated by systemd-fstab-generator\n\n" - "[Unit]\n" - "SourcePath=%s\n", - source); + "# Automatically generated by systemd-fstab-generator\n\n" + "[Unit]\n" + "SourcePath=%s\n" + "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n", + source); if (post && !noauto && !nofail && !automount) fprintf(f, @@ -278,7 +280,8 @@ static int add_mount( fprintf(f, "# Automatically generated by systemd-fstab-generator\n\n" "[Unit]\n" - "SourcePath=%s\n", + "SourcePath=%s\n" + "Documentation=man:fstab(5) man:systemd-fstab-generator(8)\n", source); if (post) diff --git a/src/gpt-auto-generator/gpt-auto-generator.c b/src/gpt-auto-generator/gpt-auto-generator.c index c4109f39b..eb900b126 100644 --- a/src/gpt-auto-generator/gpt-auto-generator.c +++ b/src/gpt-auto-generator/gpt-auto-generator.c @@ -145,7 +145,8 @@ static int add_swap(const char *path, const char *fstype) { fprintf(f, "# Automatically generated by systemd-gpt-auto-generator\n\n" "[Unit]\n" - "Description=Swap Partition\n\n" + "Description=Swap Partition\n" + "Documentation=man:systemd-gpt-auto-generator(8)\n\n" "[Swap]\n" "What=%s\n", path); @@ -205,7 +206,7 @@ static int add_cryptsetup(const char *id, const char *what, char **device) { "# Automatically generated by systemd-gpt-auto-generator\n\n" "[Unit]\n" "Description=Cryptography Setup for %%I\n" - "Documentation=man:systemd-cryptsetup@.service(8)\n" + "Documentation=man:systemd-gpt-auto-generator(8) man:systemd-cryptsetup@.service(8)\n" "DefaultDependencies=no\n" "Conflicts=umount.target\n" "BindsTo=dev-mapper-%%i.device %s\n" @@ -331,7 +332,8 @@ static int add_mount(const char *id, const char *what, const char *where, const fprintf(f, "# Automatically generated by systemd-gpt-auto-generator\n\n" "[Unit]\n" - "Description=%s\n", + "Description=%s\n" + "Documentation=man:systemd-gpt-auto-generator(8)\n", description); r = generator_write_fsck_deps(f, arg_dest, what, where, fstype); -- 2.30.2