commit da089cf63a1377fe8febcf1bf6d0d323a0077e02 · pyrox.dev/nixpkgs

+22 -6
nixos/modules/misc/mandoc.nix
···

       41
       41
        
               '';

     

       42
       42
        
             };

     

       43
       43
        
       

     

       44
       44
       +
             cachePath = lib.mkOption {

     

       45
       45
       +
               type = with lib.types; listOf str;

     

       46
       46
       +
               default = cfg.manPath;

     

       47
       47
       +
               defaultText = lib.literalExpression "config.documentation.man.mandoc.manPath";

     

       48
       48
       +
               example = lib.literalExpression "[ \"share/man\" \"share/man/fr\" ]";

     

       49
       49
       +
               description = ''

     

       50
       50
       +
                 Change the paths where mandoc {manpage}`makewhatis(8)`generates the

     

       51
       51
       +
                 manual page index caches. {option}`documentation.man.generateCaches`

     

       52
       52
       +
                 should be enabled to allow cache generation. This list should only

     

       53
       53
       +
                 include the paths to manpages installed in the system configuration,

     

       54
       54
       +
                 i. e. /run/current-system/sw/share/man. {manpage}`makewhatis(8)`

     

       55
       55
       +
                 creates a database in each directory using the files

     

       56
       56
       +
                 `mansection/[arch/]title.section` and `catsection/[arch/]title.0`

     

       57
       57
       +
                 in it. If a directory contains no manual pages, no database is

     

       58
       58
       +
                 created in that directory.

     

       59
       59
       +
                 This option only needs to be set manually if extra paths should be

     

       60
       60
       +
                 indexed or {option}`documentation.man.manPath` contains paths that

     

       61
       61
       +
                 can't be indexed.

     

       62
       62
       +
               '';

     

       63
       63
       +
             };

     

       64
       64
       +
       

     

       44
       65
        
             package = lib.mkOption {

     

       45
       66
        
               type = lib.types.package;

     

       46
       67
        
               default = pkgs.mandoc;

     
···

       178
       199
        
             # TODO(@sternenseemman): fix symlinked directories not getting indexed,

     

       179
       200
        
             # see: https://inbox.vuxu.org/mandoc-tech/20210906171231.GF83680@athene.usta.de/T/#e85f773c1781e3fef85562b2794f9cad7b2909a3c

     

       180
       201
        
             extraSetup = lib.mkIf config.documentation.man.generateCaches ''

     

       181
       181
       -
               for man_path in ${

     

       182
       182
       -
                 lib.concatMapStringsSep " " (path:

     

       183
       183
       -
                   "$out/" + lib.escapeShellArg path

     

       184
       184
       -
                   ) cfg.manPath} ${lib.concatMapStringsSep " " (path:

     

       185
       185
       -
                   lib.escapeShellArg path) cfg.settings.manpath

     

       186
       186
       -
                 }

     

       202
       202
       +
               for man_path in ${lib.concatMapStringsSep " " (path: "$out/" + lib.escapeShellArg path) cfg.cachePath}

     

       187
       203
        
               do

     

       188
       204
        
                 [[ -d "$man_path" ]] && ${makewhatis} -T utf8 $man_path

     

       189
       205
        
               done