From 5ffd52334052e0b6074992a964bc1a85c96bade5 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Thu, 15 Nov 2012 14:33:08 +0100 Subject: [PATCH] doc and doc building update Signed-off-by: Nico Schottelius --- build | 36 +++++++++++++++---------------- docs/web/cdist/documentation.mdwn | 6 ++++-- docs/web/cdist/update.mdwn | 16 ++++++++------ 3 files changed, 31 insertions(+), 27 deletions(-) diff --git a/build b/build index baad93be..f1e0bf8e 100755 --- a/build +++ b/build @@ -1,6 +1,6 @@ #!/bin/sh # -# 2011 Nico Schottelius (nico-cdist at schottelius.org) +# 2011-2012 Nico Schottelius (nico-cdist at schottelius.org) # # This file is part of cdist. # @@ -34,9 +34,10 @@ A2XM="a2x -f manpage --no-xmllint -a encoding=UTF-8" A2XH="a2x -f xhtml --no-xmllint -a encoding=UTF-8" # Developer webbase -WEBDIR=$HOME/niconetz +WEBDIR=$HOME/www.nico.schottelius.org WEBBLOG=$WEBDIR/blog -WEBBASE=$WEBDIR/software/cdist +WEBTOPDIR=$WEBDIR/software +WEBBASE=$WEBTOPDIR/cdist WEBMAN=$WEBBASE/man/$version WEBPAGE=${WEBBASE}.mdwn @@ -89,6 +90,13 @@ case "$1" in ${MANDIR}/cdist-reference.text.sh ;; + man-pub) + rm -rf "${WEBMAN}" + mkdir -p "${WEBMAN}/man1" "${WEBMAN}/man7" + cp ${MAN1DSTDIR}/*.html ${MAN1DSTDIR}/*.css ${WEBMAN}/man1 + cp ${MAN7DSTDIR}/*.html ${MAN7DSTDIR}/*.css ${WEBMAN}/man7 + ;; + dist) set -e # Do the checks @@ -314,23 +322,15 @@ eof done ;; - webmain) - cp README ${WEBPAGE} - cd ${WEBDIR} && git commit -m "cdist main update" ${WEBPAGE} - cd ${WEBDIR} && make pub - ;; - web) - cp README ${WEBPAGE} - rm -rf ${WEBMAN} - mkdir -p ${WEBMAN}/man1 ${WEBMAN}/man7 + set -e + rsync -av "${basedir}/docs/web/" "${WEBTOPDIR}" - cp ${MAN1DSTDIR}/*.html ${MAN1DSTDIR}/*.css ${WEBMAN}/man1 - cp ${MAN7DSTDIR}/*.html ${MAN7DSTDIR}/*.css ${WEBMAN}/man7 - - cd ${WEBDIR} && git add ${WEBBASE} - cd ${WEBDIR} && git commit -m "cdist update" ${WEBBASE} ${WEBPAGE} - cd ${WEBDIR} && make pub + $0 man-pub + + cd "${WEBDIR}" && git add "${WEBBASE}" + cd "${WEBDIR}" && git commit -m "cdist update" "${WEBBASE}" "${WEBPAGE}" + cd "${WEBDIR}" && make pub # Fix ikiwiki, which does not like symlinks for pseudo security ssh tee.schottelius.org \ diff --git a/docs/web/cdist/documentation.mdwn b/docs/web/cdist/documentation.mdwn index aa751a4b..ba829101 100644 --- a/docs/web/cdist/documentation.mdwn +++ b/docs/web/cdist/documentation.mdwn @@ -1,5 +1,7 @@ +[[!meta title="Documentation"]] -* [Latest documentation](man/latest) -* [All versions](man) +You can browse the latest +[latest version of the manpages](man/latest) or +have a look at [all versions](man). [[!tag cdist unix]] diff --git a/docs/web/cdist/update.mdwn b/docs/web/cdist/update.mdwn index a916575a..7fac8444 100644 --- a/docs/web/cdist/update.mdwn +++ b/docs/web/cdist/update.mdwn @@ -24,18 +24,20 @@ To upgrade to the lastet version do ### Updating from 2.0 to 2.1 - * Type __package* and __process use --state **present** or **absent**. + * Type **\_\_package* and \_\_process** use --state **present** or **absent**. The states **removed/installed** and **stopped/running** have been removed. Support for the new states is already present in 2.0. - * Type __directory: Parameter --parents and --recursive are now boolean - and the old "yes/no" values need to be removed - * Type **__addifnosuchline** and **__removeline** have been replaced by **__line** + * Type **\_\_directory**: Parameter --parents and --recursive are now boolean + The old "yes/no" values need to be removed. + * Type **\_\_rvm_ruby**: Parameter --default is now boolean + The old "yes/no" values need to be removed. + * Type **\_\_addifnosuchline** and **\_\_removeline** have been replaced by **\_\_line** * The **conf** directory is now located at **cdist/conf**. You need to migrate your types, explorers and manifests manually to the new location. - * Replace the variable **__self** by **__object_name** - Support for the variable **__object_name** is already present in 2.0. - * The types __autofs, __autofs_map and __autofs_reload have been removed + * Replace the variable **\_\_self** by **\_\_object_name** + Support for the variable **\_\_object_name** is already present in 2.0. + * The types **\_\_autofs**, **\_\_autofs_map** and **\_\_autofs_reload** have been removed (no maintainer, no users)