commit bc0421c4cf18c431ece8d6a19f723159316f55ff · pyrox.dev/nixpkgs

doc/Makefile

···

       12
       12
        
       	find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \

     

       13
       13
        
       		xmlformat --config-file "$$XMLFORMAT_CONFIG" -i {}

     

       14
       14
        
       

     

       15
       15
       +
       .PHONY: fix-misc-xml

     

       16
       16
       +
       fix-misc-xml:

     

       17
       17
       +
       	find . -iname '*.xml' -type f \

     

       18
       18
       +
       		-exec ../nixos/doc/varlistentry-fixer.rb {} ';'

     

       19
       19
       +
       

     

       15
       20
        
       .PHONY: clean

     

       16
       21
        
       clean:

     

       17
       22
        
       	rm -f ${MD_TARGETS} .version manual-full.xml

+1 -1

doc/shell.nix

···

       1
       1
        
       { pkgs ? import ../. {} }:

     

       2
       2
        
       (import ./default.nix).overrideAttrs (x: {

     

       3
       3
       -
         buildInputs = x.buildInputs ++ [ pkgs.xmloscopy ];

     

       3
       3
       +
         buildInputs = x.buildInputs ++ [ pkgs.xmloscopy pkgs.ruby ];

     

       4
       4
        
       

     

       5
       5
        
       })

nixos/doc/manual/Makefile

···

       14
       14
        
       	find . -iname '*.xml' -type f -print0 | xargs -0 -I{} -n1 \

     

       15
       15
        
       		xmlformat --config-file "../xmlformat.conf" -i {}

     

       16
       16
        
       

     

       17
       17
       +
       .PHONY: fix-misc-xml

     

       18
       18
       +
       fix-misc-xml:

     

       19
       19
       +
       	find . -iname '*.xml' -type f \

     

       20
       20
       +
       		-exec ../varlistentry-fixer.rb {} ';'

     

       21
       21
       +
       

     

       17
       22
        
       .PHONY: clean

     

       18
       23
        
       clean:

     

       19
       24
        
       	rm -f manual-combined.xml generated

+1 -1

nixos/doc/manual/shell.nix

···

       4
       4
        
       pkgs.mkShell {

     

       5
       5
        
         name = "nixos-manual";

     

       6
       6
        
       

     

       7
       7
       -
         buildInputs = with pkgs; [ xmlformat jing xmloscopy ];

     

       7
       7
       +
         buildInputs = with pkgs; [ xmlformat jing xmloscopy ruby ];

     

       8
       8
        
       }

+124

nixos/doc/varlistentry-fixer.rb

···

       1
       1
       +
       #!/usr/bin/env ruby

     

       2
       2
       +
       

     

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

     

       4
       4
       +
       # to fix oopsies within the docbook documentation.

     

       5
       5
       +
       #

     

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

     

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

     

       8
       8
       +
       #

     

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

     

       10
       10
       +
       #

     

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

     

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

     

       13
       13
       +
       

     

       14
       14
       +
       require "rexml/document"

     

       15
       15
       +
       include REXML

     

       16
       16
       +
       

     

       17
       17
       +
       if ARGV.length < 1 then

     

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

     

       19
       19
       +
       	exit 1

     

       20
       20
       +
       end

     

       21
       21
       +
       

     

       22
       22
       +
       filename = ARGV.shift

     

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

     

       24
       24
       +
       

     

       25
       25
       +
       $touched = false

     

       26
       26
       +
       

     

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

     

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

     

       29
       29
       +
       # would mangle as spaces.

     

       30
       30
       +
       #

     

       31
       31
       +
       #   <varlistentry>

     

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

     

       33
       33
       +
       #    </term>

     

       34
       34
       +
       #    ...

     

       35
       35
       +
       #

     

       36
       36
       +
       # Generates: types.separatedStringsep

     

       37
       37
       +
       #                               ^^^^

     

       38
       38
       +
       #

     

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

     

       40
       40
       +
       #  <term>

     

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

     

       42
       42
       +
       #  </term>

     

       43
       43
       +
       #

     

       44
       44
       +
       # Generates: makeWrapperexecutablewrapperfileargs

     

       45
       45
       +
       #                     ^^^^      ^^^^    ^^  ^^

     

       46
       46
       +
       #

     

       47
       47
       +
       #    <term>

     

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

     

       49
       49
       +
       #    </term>

     

       50
       50
       +
       #

     

       51
       51
       +
       # Generates: --optionnamevalue

     

       52
       52
       +
       #                   ^^  ^^

     

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

     

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

     

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

     

       56
       56
       +
       			if el.next_element and

     

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

     

       58
       58
       +
       					el.next_sibling_node.class == Element

     

       59
       59
       +
       				then

     

       60
       60
       +
       				$touched = true

     

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

     

       62
       62
       +
       			end

     

       63
       63
       +
       		end

     

       64
       64
       +
       	end

     

       65
       65
       +
       end

     

       66
       66
       +
       

     

       67
       67
       +
       

     

       68
       68
       +
       

     

       69
       69
       +
       #  <cmdsynopsis>

     

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

     

       71
       71
       +
       #   <arg>

     

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

     

       73
       73
       +
       #   </arg>

     

       74
       74
       +
       #

     

       75
       75
       +
       # Generates: -Ipath

     

       76
       76
       +
       #             ^^

     

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

     

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

     

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

     

       80
       80
       +
       			if el.next_element and

     

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

     

       82
       82
       +
       				el.next_sibling_node.class == Element

     

       83
       83
       +
       			then

     

       84
       84
       +
       				$touched = true

     

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

     

       86
       86
       +
       			end

     

       87
       87
       +
       		end

     

       88
       88
       +
       	end

     

       89
       89
       +
       end

     

       90
       90
       +
       

     

       91
       91
       +
       #  <cmdsynopsis>

     

       92
       92
       +
       #   <arg>

     

       93
       93
       +
       #    <group choice='req'>

     

       94
       94
       +
       #    <arg choice='plain'>

     

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

     

       96
       96
       +
       #    </arg>

     

       97
       97
       +
       #

     

       98
       98
       +
       #    <arg choice='plain'>

     

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

     

       100
       100
       +
       #    </arg>

     

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

     

       102
       102
       +
       #   </arg>

     

       103
       103
       +
       #

     

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

     

       105
       105
       +
       #                                   ^^^^

     

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

     

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

     

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

     

       109
       109
       +
       			if el.next_element and

     

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

     

       111
       111
       +
       				el.next_sibling_node.class == Element

     

       112
       112
       +
       			then

     

       113
       113
       +
       				$touched = true

     

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

     

       115
       115
       +
       			end

     

       116
       116
       +
       		end

     

       117
       117
       +
       	end

     

       118
       118
       +
       end

     

       119
       119
       +
       

     

       120
       120
       +
       

     

       121
       121
       +
       if $touched then

     

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

     

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

     

       124
       124
       +
       end