From fcacf646797d84e434f9200cd7b3b22efa66546b Mon Sep 17 00:00:00 2001 From: Jephte Clain Date: Wed, 11 May 2016 07:30:14 +0400 Subject: [PATCH] maj doc --- doc/udir.md | 11 ++++++----- doc/udir.twp | 13 +++++++------ doc/ulib_java.md | 5 +++++ doc/update-md | 12 ++++++++---- doc/update-twp | 15 +++++++++------ 5 files changed, 35 insertions(+), 21 deletions(-) diff --git a/doc/udir.md b/doc/udir.md index b5d5ec6..e76b1a6 100644 --- a/doc/udir.md +++ b/doc/udir.md @@ -15,19 +15,20 @@ pour définir un tableau: udir /path/to/dir 'array=(first second)' OPTIONS - -i + -i, --show-desc + -n, --show-note Afficher la description du répertoire. C'est l'action par défaut si ce script est lancé *sans argument* - -d + -d, --dump Afficher toutes les variables définies pour le répertoire 'dir'. - -x 'cmds;...' + -x, --eval 'CMDS;...' Exécuter les commandes dans le contexte des variables définies pour le répertoire. - -e + -e, --edit Editer les variables du répertoire --local-vars Avec -d, ajouter des directives 'local' aux définitions de variables - -A + -A, --all-parents Avec -d et -x, considérer les variables de tous les répertoires parents jusqu'à la racine. Pour ne considérer que les variables du répertoire spécifié (par défaut), utiliser --local-only diff --git a/doc/udir.twp b/doc/udir.twp index d0b7310..be8e9f6 100644 --- a/doc/udir.twp +++ b/doc/udir.twp @@ -1,6 +1,6 @@ # -*- coding: utf-8 mode: markdown -*- vim:sw=4:sts=4:et:ai:si:sta:fenc=utf-8 ##@creator: jclain -##@created: 27/04/2016 03:19 +##@created: 11/05/2016 07:29 ##@modifier: jclain ##@changecount: 1 ##@tags: @@ -21,19 +21,20 @@ pour définir un tableau: udir /path/to/dir 'array=(first second)' OPTIONS - -i + -i, --show-desc + -n, --show-note Afficher la description du répertoire. C'est l'action par défaut si ce script est lancé *sans argument* - -d + -d, --dump Afficher toutes les variables définies pour le répertoire 'dir'. - -x 'cmds;...' + -x, --eval 'CMDS;...' Exécuter les commandes dans le contexte des variables définies pour le répertoire. - -e + -e, --edit Editer les variables du répertoire --local-vars Avec -d, ajouter des directives 'local' aux définitions de variables - -A + -A, --all-parents Avec -d et -x, considérer les variables de tous les répertoires parents jusqu'à la racine. Pour ne considérer que les variables du répertoire spécifié (par défaut), utiliser --local-only diff --git a/doc/ulib_java.md b/doc/ulib_java.md index 2fdab33..73eb832 100644 --- a/doc/ulib_java.md +++ b/doc/ulib_java.md @@ -22,6 +22,11 @@ l'ordre, jusqu'à ce qu'un argument corresponde. DEFAULT correspond à la valeur actuelle de JAVA_HOME, si elle est définie. Si aucun argument n'est défini, on assume "DEFAULT 5 6 7 8 1.4" ~~~ +## `get_java_version` +~~~ +Afficher la version de java qui installée dans $1(=$JAVA_HOME) +En cas d'erreur, ne rien afficher. +~~~ ## `get_default_javahome_prefix` ## `get_javaextensions_prefix` ## `compute_java_prefixes` diff --git a/doc/update-md b/doc/update-md index db60af8..3e13b26 100755 --- a/doc/update-md +++ b/doc/update-md @@ -10,8 +10,12 @@ USAGE $scriptname [options] OPTIONS - -t Ne générer la documentation que pour les outils - -l Ne générer la documentation que pour ulib + -t, --tools + Ne générer la documentation que pour les outils. S'il ne faut regénérer + la documentation que pour certains outils, il suffit de les lister en + arguments. + -l, --ulib + Ne générer la documentation que pour ulib Par défaut, la documentation est (re)générée pour les outils et pour ulib" } @@ -44,8 +48,8 @@ ulib= force= parse_opts "${PRETTYOPTS[@]}" \ --help '$exit_with display_help' \ - -t '$auto=; tools=1' \ - -l '$auto=; ulib=1' \ + -t,--tools '$auto=; tools=1' \ + -l,--ulib '$auto=; ulib=1' \ --force force=1 \ @ args -- "$@" && set -- "${args[@]}" || die "$args" diff --git a/doc/update-twp b/doc/update-twp index c7ade4c..0fc5012 100755 --- a/doc/update-twp +++ b/doc/update-twp @@ -10,9 +10,12 @@ USAGE $scriptname [options] OPTIONS - -t Ne générer la documentation que pour les outils - -l Ne générer la documentation que pour ulib - -s Synchroniser avec nutools.html après la génération de la documentation + -t, --tools + Ne générer la documentation que pour les outils + -l, --ulib + Ne générer la documentation que pour ulib + -s, --sync + Synchroniser avec nutools.html après la génération de la documentation Par défaut, la documentation est (re)générée pour les outils et pour ulib" } @@ -50,9 +53,9 @@ sync= force= parse_opts "${PRETTYOPTS[@]}" \ --help '$exit_with display_help' \ - -t '$auto=; tools=1' \ - -l '$auto=; ulib=1' \ - -s '$auto=; sync=1' \ + -t,--tools '$auto=; tools=1' \ + -l,--ulib '$auto=; ulib=1' \ + -s,--sync '$auto=; sync=1' \ --force force=1 \ @ args -- "$@" && set -- "${args[@]}" || die "$args"