Rm cdist-type prefix and man page ref from docs
E.g. 16.10. __block 16.11. __ccollect_source 16.12. __cdist 16.13. __cdistmarker 16.14. __check_messages insted of 16.10. cdist-type__block(7) 16.11. cdist-type__ccollect_source(7) 16.12. cdist-type__cdist(7) 16.13. cdist-type__cdistmarker(7) 16.14. cdist-type__check_messages(7)
This commit is contained in:
		
					parent
					
						
							
								90e85d8128
							
						
					
				
			
			
				commit
				
					
						71b6646b38
					
				
			
		
					 4 changed files with 65 additions and 9 deletions
				
			
		
							
								
								
									
										1
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							| 
						 | 
				
			
			@ -24,6 +24,7 @@ docs/src/man1/*.1
 | 
			
		|||
docs/src/man7/*.7
 | 
			
		||||
docs/src/man7/cdist-type__*.rst
 | 
			
		||||
docs/src/cdist-reference.rst
 | 
			
		||||
docs/src/cdist-types.rst
 | 
			
		||||
docs/src/cdist.cfg.skeleton
 | 
			
		||||
 | 
			
		||||
# Ignore cdist cache for version control
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
							
								
								
									
										10
									
								
								Makefile
									
										
									
									
									
								
							
							
						
						
									
										10
									
								
								Makefile
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -63,6 +63,13 @@ DOCSREFSH=$(DOCS_SRC_DIR)/cdist-reference.rst.sh
 | 
			
		|||
$(DOCSREF): $(DOCSREFSH)
 | 
			
		||||
	$(DOCSREFSH)
 | 
			
		||||
 | 
			
		||||
# Html types list with references
 | 
			
		||||
DOCSTYPESREF=$(MAN7DSTDIR)/cdist-types.rst
 | 
			
		||||
DOCSTYPESREFSH=$(DOCS_SRC_DIR)/cdist-types.rst.sh
 | 
			
		||||
 | 
			
		||||
$(DOCSTYPESREF): $(DOCSTYPESREFSH)
 | 
			
		||||
	$(DOCSTYPESREFSH)
 | 
			
		||||
 | 
			
		||||
DOCSCFGSKEL=./configuration/cdist.cfg.skeleton
 | 
			
		||||
 | 
			
		||||
configskel: $(DOCSCFGSKEL)
 | 
			
		||||
| 
						 | 
				
			
			@ -77,7 +84,7 @@ version:
 | 
			
		|||
man: version $(MANTYPES) $(DOCSREF)
 | 
			
		||||
	$(SPHINXM)
 | 
			
		||||
 | 
			
		||||
html: version configskel $(MANTYPES) $(DOCSREF)
 | 
			
		||||
html: version configskel $(MANTYPES) $(DOCSREF) $(DOCSTYPESREF)
 | 
			
		||||
	$(SPHINXH)
 | 
			
		||||
 | 
			
		||||
docs: man html
 | 
			
		||||
| 
						 | 
				
			
			@ -119,6 +126,7 @@ speeches: $(SPEECHES)
 | 
			
		|||
#
 | 
			
		||||
clean: docs-clean
 | 
			
		||||
	rm -f $(DOCS_SRC_DIR)/cdist-reference.rst
 | 
			
		||||
	rm -f $(DOCS_SRC_DIR)/cdist-types.rst
 | 
			
		||||
	rm -f $(DOCS_SRC_DIR)/cdist.cfg.skeleton
 | 
			
		||||
 | 
			
		||||
	find "$(DOCS_SRC_DIR)" -mindepth 2 -type l \
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,8 +0,0 @@
 | 
			
		|||
cdist types
 | 
			
		||||
===========
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
   :titlesonly:
 | 
			
		||||
   :glob:
 | 
			
		||||
 | 
			
		||||
   man7/*
 | 
			
		||||
							
								
								
									
										55
									
								
								docs/src/cdist-types.rst.sh
									
										
									
									
									
										Executable file
									
								
							
							
						
						
									
										55
									
								
								docs/src/cdist-types.rst.sh
									
										
									
									
									
										Executable file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,55 @@
 | 
			
		|||
#!/bin/sh
 | 
			
		||||
#
 | 
			
		||||
# 2019 Darko Poljak (darko.poljak at gmail.com) 
 | 
			
		||||
#
 | 
			
		||||
# This file is part of cdist.
 | 
			
		||||
#
 | 
			
		||||
# cdist is free software: you can redistribute it and/or modify
 | 
			
		||||
# it under the terms of the GNU General Public License as published by
 | 
			
		||||
# the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
# (at your option) any later version.
 | 
			
		||||
#
 | 
			
		||||
# cdist is distributed in the hope that it will be useful,
 | 
			
		||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
# GNU General Public License for more details.
 | 
			
		||||
#
 | 
			
		||||
# You should have received a copy of the GNU General Public License
 | 
			
		||||
# along with cdist. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
#
 | 
			
		||||
#
 | 
			
		||||
# Generate cdist-types.rst that lists available types.
 | 
			
		||||
#
 | 
			
		||||
 | 
			
		||||
__cdist_pwd="$(pwd -P)"
 | 
			
		||||
__cdist_mydir="${0%/*}";
 | 
			
		||||
__cdist_abs_mydir="$(cd "$__cdist_mydir" && pwd -P)"
 | 
			
		||||
__cdist_myname=${0##*/};
 | 
			
		||||
__cdist_abs_myname="$__cdist_abs_mydir/$__cdist_myname"
 | 
			
		||||
 | 
			
		||||
filename="${__cdist_myname%.sh}"
 | 
			
		||||
dest="$__cdist_abs_mydir/$filename"
 | 
			
		||||
 | 
			
		||||
cd "$__cdist_abs_mydir"
 | 
			
		||||
 | 
			
		||||
exec > "$dest"
 | 
			
		||||
cat << eof 
 | 
			
		||||
cdist types
 | 
			
		||||
===========
 | 
			
		||||
 | 
			
		||||
.. toctree::
 | 
			
		||||
   :titlesonly:
 | 
			
		||||
 | 
			
		||||
eof
 | 
			
		||||
 | 
			
		||||
# If there is no such file then ls prints error to stderr,
 | 
			
		||||
# so redirect stderr to /dev/null.
 | 
			
		||||
for type in $(ls man7/cdist-type__*.rst 2>/dev/null | LC_ALL=C sort); do
 | 
			
		||||
    no_dir="${type#man7/}";
 | 
			
		||||
    no_type="${no_dir#cdist-type}";
 | 
			
		||||
    name="${no_type%.rst}";
 | 
			
		||||
    manref="${no_dir%.rst}"
 | 
			
		||||
    man="${manref}(7)"
 | 
			
		||||
 | 
			
		||||
    echo "   $name" "<man7/${manref}>"
 | 
			
		||||
done
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue