Begin to include html version of manpages
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
parent
87cc5c2bbf
commit
4553333ddb
2 changed files with 18 additions and 5 deletions
14
Makefile
14
Makefile
|
@ -9,8 +9,8 @@ A2XM=a2x -f manpage --no-xmllint
|
|||
A2XH=asciidoc -b xhtml11
|
||||
|
||||
# Developer only
|
||||
WEBDIR=$$HOME/niconetz
|
||||
WEBPAGE=software/cdist.mdwn
|
||||
WEBPAGEBASE=$$HOME/niconetz/software/cdist
|
||||
WEBPAGE=$(WEBPAGEBASE).mdwn
|
||||
|
||||
# Documentation
|
||||
MANDIR=doc/man
|
||||
|
@ -52,7 +52,7 @@ all:
|
|||
@echo ''
|
||||
@echo 'Here are the possible targets:'
|
||||
@echo ''
|
||||
@echo ' man: Build manpages (requires Asciidoc (a2x binary))'
|
||||
@echo ' man: Build manpages (requires Asciidoc)'
|
||||
@echo ' clean: Remove build stuff'
|
||||
@echo ''
|
||||
@echo ''
|
||||
|
@ -97,6 +97,7 @@ $(MANDIR)/cdist-reference.text: manmove $(MANDIR)/cdist-reference.text.sh
|
|||
clean:
|
||||
rm -rf doc/man/*.html doc/man/*.[1-9] doc/man/man[1-9] $(MANGENERATED)
|
||||
rm -f conf/type/*/man.html
|
||||
rm -rf doc/html
|
||||
|
||||
################################################################################
|
||||
# Developer targets
|
||||
|
@ -110,9 +111,12 @@ test:
|
|||
# gentoo
|
||||
.rsync nicosc@ru3.inf.ethz.ch:cdist
|
||||
|
||||
#web: manmove
|
||||
web:
|
||||
cp README $(WEBDIR)/$(WEBPAGE)
|
||||
cd $(WEBDIR) && git commit -m "cdist update" $(WEBPAGE)
|
||||
cp README $(WEBPAGE)
|
||||
cp -r doc/html/* $(WEBPAGEBASE)/man
|
||||
exit 1
|
||||
cd $(WEBDIR) && git commit -m "cdist update" $(WEBPAGEBASE)
|
||||
cd $(WEBDIR) && make pub
|
||||
|
||||
pub:
|
||||
|
|
9
README
9
README
|
@ -37,6 +37,11 @@ it ticks differently:
|
|||
* cdist is written in POSIX shell
|
||||
* 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
|
||||
|
||||
* 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
|
||||
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
|
||||
|
||||
No incompatiblities.
|
||||
|
|
Loading…
Reference in a new issue