commit bfc6975cbc399cac0719b9305a8ac0fedb957aca · pyrox.dev/nixpkgs

+1 -1

doc/doc-support/default.nix

···

       75
        
           ln -s ${epub-xsl} ./epub.xsl

     

       76
        
           ln -s ${xhtml-xsl} ./xhtml.xsl

     

       77
        
       

     

       78
       -
           ln -s ${../../nixos/doc/xmlformat.conf} ./xmlformat.conf

     

       79
        
           ln -s ${pkgs.documentation-highlighter} ./highlightjs

     

       80
        
       

     

       81
        
           echo -n "${version}" > ./version

···

       75
        
           ln -s ${epub-xsl} ./epub.xsl

     

       76
        
           ln -s ${xhtml-xsl} ./xhtml.xsl

     

       77
        
       

     

       78
       +
           ln -s ${./xmlformat.conf} ./xmlformat.conf

     

       79
        
           ln -s ${pkgs.documentation-highlighter} ./highlightjs

     

       80
        
       

     

       81
        
           echo -n "${version}" > ./version

-2

nixos/doc/manual/.gitignore

···

       1
       -
       generated

     

       2
       -
       manual-combined.xml

-30

nixos/doc/manual/Makefile

···

       1
       -
       .PHONY: all

     

       2
       -
       all: manual-combined.xml

     

       3
       -
       

     

       4
       -
       .PHONY: debug

     

       5
       -
       debug: generated manual-combined.xml

     

       6
       -
       

     

       7
       -
       manual-combined.xml: generated *.xml **/*.xml

     

       8
       -
       	rm -f ./manual-combined.xml

     

       9
       -
       	nix-shell --pure -Q --packages xmloscopy \

     

       10
       -
       		--run "xmloscopy --docbook5 ./manual.xml ./manual-combined.xml"

     

       11
       -
       

     

       12
       -
       .PHONY: format

     

       13
       -
       format:

     

       14
       -
       	nix-shell --pure -Q --packages xmlformat \

     

       15
       -
       		--run "find ../../ -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \

     

       16
       -
       		xmlformat --config-file '../xmlformat.conf' -i {}"

     

       17
       -
       

     

       18
       -
       .PHONY: fix-misc-xml

     

       19
       -
       fix-misc-xml:

     

       20
       -
       	find . -iname '*.xml' -type f \

     

       21
       -
       		-exec ../varlistentry-fixer.rb {} ';'

     

       22
       -
       

     

       23
       -
       .PHONY: clean

     

       24
       -
       clean:

     

       25
       -
       	rm -f manual-combined.xml generated

     

       26
       -
       

     

       27
       -
       generated:

     

       28
       -
       	nix-build ../../release.nix \

     

       29
       -
       		--attr manualGeneratedSources.x86_64-linux \

     

       30
       -
       		--out-link ./generated

-8

nixos/doc/manual/shell.nix

···

       1
       -
       let

     

       2
       -
         pkgs = import ../../.. { };

     

       3
       -
       in

     

       4
       -
       pkgs.mkShell {

     

       5
       -
         name = "nixos-manual";

     

       6
       -
       

     

       7
       -
         packages = with pkgs; [ xmlformat jing xmloscopy ruby ];

     

       8
       -
       }

-124

nixos/doc/varlistentry-fixer.rb

···

       1
       -
       #!/usr/bin/env ruby

     

       2
       -
       

     

       3
       -
       # This script is written intended as a living, evolving tooling

     

       4
       -
       # to fix oopsies within the docbook documentation.

     

       5
       -
       #

     

       6
       -
       # This is *not* a formatter. It, instead, handles some known cases

     

       7
       -
       # where something bad happened, and fixing it manually is tedious.

     

       8
       -
       #

     

       9
       -
       # Read the code to see the different cases it handles.

     

       10
       -
       #

     

       11
       -
       # ALWAYS `make format` after fixing with this!

     

       12
       -
       # ALWAYS read the changes, this tool isn't yet proven to be always right.

     

       13
       -
       

     

       14
       -
       require "rexml/document"

     

       15
       -
       include REXML

     

       16
       -
       

     

       17
       -
       if ARGV.length < 1 then

     

       18
       -
         $stderr.puts "Needs a filename."

     

       19
       -
         exit 1

     

       20
       -
       end

     

       21
       -
       

     

       22
       -
       filename = ARGV.shift

     

       23
       -
       doc = Document.new(File.open(filename))

     

       24
       -
       

     

       25
       -
       $touched = false

     

       26
       -
       

     

       27
       -
       # Fixing varnames having a sibling element without spacing.

     

       28
       -
       # This is to fix an initial `xmlformat` issue where `term`

     

       29
       -
       # would mangle as spaces.

     

       30
       -
       #

     

       31
       -
       #   <varlistentry>

     

       32
       -
       #    <term><varname>types.separatedString</varname><replaceable>sep</replaceable> <----

     

       33
       -
       #    </term>

     

       34
       -
       #    ...

     

       35
       -
       #

     

       36
       -
       # Generates: types.separatedStringsep

     

       37
       -
       #                               ^^^^

     

       38
       -
       #

     

       39
       -
       # <varlistentry xml:id='fun-makeWrapper'>

     

       40
       -
       #  <term>

     

       41
       -
       #   <function>makeWrapper</function><replaceable>executable</replaceable><replaceable>wrapperfile</replaceable><replaceable>args</replaceable>  <----

     

       42
       -
       #  </term>

     

       43
       -
       #

     

       44
       -
       # Generates: makeWrapperexecutablewrapperfileargs

     

       45
       -
       #                     ^^^^      ^^^^    ^^  ^^

     

       46
       -
       #

     

       47
       -
       #    <term>

     

       48
       -
       #     <option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> <-----

     

       49
       -
       #    </term>

     

       50
       -
       #

     

       51
       -
       # Generates: --optionnamevalue

     

       52
       -
       #                   ^^  ^^

     

       53
       -
       doc.elements.each("//varlistentry/term") do |term|

     

       54
       -
         ["varname", "function", "option", "replaceable"].each do |prev_name|

     

       55
       -
           term.elements.each(prev_name) do |el|

     

       56
       -
             if el.next_element and

     

       57
       -
                 el.next_element.name == "replaceable" and

     

       58
       -
                 el.next_sibling_node.class == Element

     

       59
       -
               then

     

       60
       -
               $touched = true

     

       61
       -
               term.insert_after(el, Text.new(" "))

     

       62
       -
             end

     

       63
       -
           end

     

       64
       -
         end

     

       65
       -
       end

     

       66
       -
       

     

       67
       -
       

     

       68
       -
       

     

       69
       -
       #  <cmdsynopsis>

     

       70
       -
       #   <command>nixos-option</command>

     

       71
       -
       #   <arg>

     

       72
       -
       #    <option>-I</option><replaceable>path</replaceable>        <------

     

       73
       -
       #   </arg>

     

       74
       -
       #

     

       75
       -
       # Generates: -Ipath

     

       76
       -
       #             ^^

     

       77
       -
       doc.elements.each("//cmdsynopsis/arg") do |term|

     

       78
       -
         ["option", "replaceable"].each do |prev_name|

     

       79
       -
           term.elements.each(prev_name) do |el|

     

       80
       -
             if el.next_element and

     

       81
       -
               el.next_element.name == "replaceable" and

     

       82
       -
               el.next_sibling_node.class == Element

     

       83
       -
             then

     

       84
       -
               $touched = true

     

       85
       -
               term.insert_after(el, Text.new(" "))

     

       86
       -
             end

     

       87
       -
           end

     

       88
       -
         end

     

       89
       -
       end

     

       90
       -
       

     

       91
       -
       #  <cmdsynopsis>

     

       92
       -
       #   <arg>

     

       93
       -
       #    <group choice='req'>

     

       94
       -
       #    <arg choice='plain'>

     

       95
       -
       #     <option>--profile-name</option>

     

       96
       -
       #    </arg>

     

       97
       -
       #

     

       98
       -
       #    <arg choice='plain'>

     

       99
       -
       #     <option>-p</option>

     

       100
       -
       #    </arg>

     

       101
       -
       #     </group><replaceable>name</replaceable>   <----

     

       102
       -
       #   </arg>

     

       103
       -
       #

     

       104
       -
       # Generates: [{--profile-name | -p }name]

     

       105
       -
       #                                   ^^^^

     

       106
       -
       doc.elements.each("//cmdsynopsis/arg") do |term|

     

       107
       -
         ["group"].each do |prev_name|

     

       108
       -
           term.elements.each(prev_name) do |el|

     

       109
       -
             if el.next_element and

     

       110
       -
               el.next_element.name == "replaceable" and

     

       111
       -
               el.next_sibling_node.class == Element

     

       112
       -
             then

     

       113
       -
               $touched = true

     

       114
       -
               term.insert_after(el, Text.new(" "))

     

       115
       -
             end

     

       116
       -
           end

     

       117
       -
         end

     

       118
       -
       end

     

       119
       -
       

     

       120
       -
       

     

       121
       -
       if $touched then

     

       122
       -
         doc.context[:attribute_quote] = :quote

     

       123
       -
         doc.write(output: File.open(filename, "w"))

     

       124
       -
       end

nixos/doc/xmlformat.conf doc/doc-support/xmlformat.conf