tom/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Begin to include html version of manpages

Browse source 
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius 2011-03-21 13:48:40 +01:00
commit 4553333ddb
2 changed files with 18 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
Makefile
View file

@ -9,8 +9,8 @@ A2XM=a2x -f manpage --no-xmllint
A2XH=asciidoc -b xhtml11 A2XH=asciidoc -b xhtml11
# Developer only # Developer only
WEBDIR=$$HOME/niconetz WEBPAGEBASE=$$HOME/niconetz/software/cdist
WEBPAGE=software/cdist.mdwn WEBPAGE=$(WEBPAGEBASE).mdwn
# Documentation # Documentation
MANDIR=doc/man MANDIR=doc/man
@ -52,7 +52,7 @@ all:
@echo '' @echo ''
@echo 'Here are the possible targets:' @echo 'Here are the possible targets:'
@echo '' @echo ''
@echo ' man: Build manpages (requires Asciidoc (a2x binary))' @echo ' man: Build manpages (requires Asciidoc)'
@echo ' clean: Remove build stuff' @echo ' clean: Remove build stuff'
@echo '' @echo ''
@echo '' @echo ''
@ -97,6 +97,7 @@ $(MANDIR)/cdist-reference.text: manmove $(MANDIR)/cdist-reference.text.sh
clean: clean:
rm -rf doc/man/*.html doc/man/*.[1-9] doc/man/man[1-9] $(MANGENERATED) rm -rf doc/man/*.html doc/man/*.[1-9] doc/man/man[1-9] $(MANGENERATED)
rm -f conf/type/*/man.html rm -f conf/type/*/man.html
rm -rf doc/html
################################################################################ ################################################################################
# Developer targets # Developer targets
@ -110,9 +111,12 @@ test:
# gentoo # gentoo
.rsync nicosc@ru3.inf.ethz.ch:cdist .rsync nicosc@ru3.inf.ethz.ch:cdist
#web: manmove
web: web:
cp README $(WEBDIR)/$(WEBPAGE) cp README $(WEBPAGE)
cd $(WEBDIR) && git commit -m "cdist update" $(WEBPAGE) cp -r doc/html/* $(WEBPAGEBASE)/man
exit 1
cd $(WEBDIR) && git commit -m "cdist update" $(WEBPAGEBASE)
cd $(WEBDIR) && make pub cd $(WEBDIR) && make pub
pub: pub:

9
README
View file

@ -37,6 +37,11 @@ it ticks differently:
* cdist is written in POSIX shell * cdist is written in POSIX shell
* No special requirements like high level interpreters needed on server or target * No special requirements like high level interpreters needed on server or target
### Documentation
The cdist documentation is included as manpages in the distribution.
You can [browse them online](man) as well.
### Architecture ### Architecture
* Push mode (server pushes configuration) * Push mode (server pushes configuration)
@ -151,6 +156,10 @@ If you stay on a version branche (i.e. 1.0, 1.1., ...), nothing should break.
The master branch on the other hand is the development branch and may not be The master branch on the other hand is the development branch and may not be
working, break your setup or eat the tree in your garden. working, break your setup or eat the tree in your garden.
### Upgrading from 1.2 to 1.3
Rename **gencode** of every type to **gencode-remote**.
### Upgrading from 1.1 to 1.2 ### Upgrading from 1.1 to 1.2
No incompatiblities. No incompatiblities.