diff options
author | Jan Malakhovski <oxij@oxij.org> | 2018-04-25 06:26:13 +0000 |
---|---|---|
committer | Jan Malakhovski <oxij@oxij.org> | 2018-06-13 16:25:10 +0000 |
commit | 2a5688574c5c5d9797f4b010325f799910b42af6 (patch) | |
tree | d6ec8523575f86d4fde4263ddf45807131bd023c | |
parent | eceff79fb650ab7905c3a96e8474c1e672d469ca (diff) | |
download | nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.tar nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.tar.gz nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.tar.bz2 nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.tar.lz nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.tar.xz nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.tar.zst nixlib-2a5688574c5c5d9797f4b010325f799910b42af6.zip |
nixos: doc: make `relatedPackages` a bit smarter
-rw-r--r-- | nixos/doc/manual/default.nix | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix index 2c6309474b37..fef6b2f86c85 100644 --- a/nixos/doc/manual/default.nix +++ b/nixos/doc/manual/default.nix @@ -31,11 +31,12 @@ let else p; describe = args: let + title = args.title or null; name = args.name or (lib.concatStringsSep "." args.path); path = args.path or [ args.name ]; package = args.package or (lib.attrByPath path (throw "Invalid package attribute path `${toString path}'") pkgs); in "<listitem>" - + "<para><literal>pkgs.${name} (${package.meta.name})</literal>" + + "<para><literal>${lib.optionalString (title != null) "${title} aka "}pkgs.${name} (${package.meta.name})</literal>" + lib.optionalString (!package.meta.available) " <emphasis>[UNAVAILABLE]</emphasis>" + ": ${package.meta.description or "???"}.</para>" + lib.optionalString (args ? comment) "\n<para>${args.comment}</para>" @@ -51,7 +52,7 @@ let // lib.optionalAttrs (opt ? example) { example = substFunction opt.example; } // lib.optionalAttrs (opt ? default) { default = substFunction opt.default; } // lib.optionalAttrs (opt ? type) { type = substFunction opt.type; } - // lib.optionalAttrs (opt ? relatedPackages) { relatedPackages = genRelatedPackages opt.relatedPackages; }); + // lib.optionalAttrs (opt ? relatedPackages && opt.relatedPackages != []) { relatedPackages = genRelatedPackages opt.relatedPackages; }); # We need to strip references to /nix/store/* from options, # including any `extraSources` if some modules came from elsewhere, |