Skip to Content.
Sympa Menu

sm-commit - [SM-Commit] GIT changes to master quill by Bor Kraljič (99c8fb76d75c30ca981e12a6fe0c306da9a3eeff)

sm-commit AT lists.ibiblio.org

Subject: Source Mage code commit list

List archive

Chronological Thread  
  • From: Bor Kraljič <scm AT sourcemage.org>
  • To: sm-commit AT lists.ibiblio.org
  • Subject: [SM-Commit] GIT changes to master quill by Bor Kraljič (99c8fb76d75c30ca981e12a6fe0c306da9a3eeff)
  • Date: Fri, 13 Aug 2010 15:43:10 -0500

GIT changes to master quill by Bor Kraljič <pyrobor AT ver.si>:

generate-quill-docs.sh | 56
+++++++++++++++++++++++
usr/bin/generate-quill-docs.sh | 56
-----------------------
var/lib/quill/ChangeLog | 9 +++
var/lib/quill/modules/libcompat | 2
var/lib/quill/modules/libcore | 24 +++++----
var/lib/quill/modules/libdeprecation | 1
var/lib/quill/modules/libdetails | 1
var/lib/quill/modules/site_handlers/libhackagedb | 7 ++
8 files changed, 88 insertions(+), 68 deletions(-)

New commits:
commit 99c8fb76d75c30ca981e12a6fe0c306da9a3eeff
Author: Bor Kraljič <pyrobor AT ver.si>
Commit: Bor Kraljič <pyrobor AT ver.si>

Few small fixes of bashdoc function headers & ChangeLog entry.

commit d299cd83addfeb5da5d32b380f2dc61f3d883d4f
Author: Bor Kraljič <pyrobor AT ver.si>
Commit: Bor Kraljič <pyrobor AT ver.si>

ChangeLog entry for commits acee001d491b2a42d1a0af180fb73a5c216c5d8a and
f5727e3e9e686cbb6087118defd2e44e5b82b71e.

commit 8352f4e4e0bf18541af3a7934c047fce08d4dbf3
Author: Bor Kraljič <pyrobor AT ver.si>
Commit: Bor Kraljič <pyrobor AT ver.si>

ChangeLog entry for commit 75984e554d353feb9f986cfb6413d34d7db4350a

commit db8fc70f61091f4c6f78829702c4d5501084a07b
Author: Bor Kraljič <pyrobor AT ver.si>
Commit: Bor Kraljič <pyrobor AT ver.si>

added ChangeLog entry for commit d51dd2d6f631583b03167515c438c1ca8b15a06b

commit f5727e3e9e686cbb6087118defd2e44e5b82b71e
Author: Bor Kraljič <pyrobor AT ver.si>
Commit: Bor Kraljič <pyrobor AT ver.si>

moved usr/bin/generate-quill-docs.sh -> generate-quill-docs.sh

diff --git a/generate-quill-docs.sh b/generate-quill-docs.sh
new file mode 100755
index 0000000..c19dd66
--- /dev/null
+++ b/generate-quill-docs.sh
@@ -0,0 +1,56 @@
+#!/bin/bash
+
+#
+# This script will generate bash documentation (for as far as it has been
made
+# available in the code) from Quill.
+#
+BIN=/usr/bin
+DOCDIR=/usr/share/doc/quill/htmldocs
+BASHDOC=$BIN/bashdoc.sh
+FLOW=$BIN/flow.sh
+SRC2HTML=$BIN/src2html.sh
+PROJECT=Quill
+
+QUIET=${QUIET:--q -q}
+
+SCRIPTS="/var/lib/quill/modules/lib* /var/lib/quill/modules/site_handlers/* \
+/usr/bin/quill"
+#exclude non-sorcery files, like backups~ or numbered versions
+for FILE in $SCRIPTS
+do
+ if grep -q "[0-9]" <<< $FILE; then
+ if grep -Eq "(libgcc2|api[12])" <<< $FILE; then
+ SCRIPTS2="$SCRIPTS2 $FILE"
+ fi
+ elif grep -q '~' <<< $FILE; then
+ true
+ else
+ SCRIPTS2="$SCRIPTS2 $FILE"
+ fi
+done
+SCRIPTS="$SCRIPTS2"
+
+# make the bashdoc dir
+if [ -d $DOCDIR ] ; then
+ rm -rf $DOCDIR
+ mkdir -p $DOCDIR
+else
+ mkdir -p $DOCDIR
+fi
+
+# generate docs for libs
+if [ -x "$BASHDOC" ] ; then
+ $BASHDOC ${QUIET} -p $PROJECT -o $DOCDIR $SCRIPTS
+else
+ echo "The bashdoc tools are not installed, please cast bashdoc!"
+fi
+
+${SRC2HTML} --funcs $DOCDIR $SCRIPTS
+if which dot >/dev/null 2>&1 ; then
+ ${FLOW} --funcs $DOCDIR --exclude debug --exclude query \
+ --exclude message --exclude error_msg $SCRIPTS
+else
+ echo "No graphviz found, not generating images."
+fi
+
+# end
diff --git a/usr/bin/generate-quill-docs.sh b/usr/bin/generate-quill-docs.sh
deleted file mode 100755
index c19dd66..0000000
--- a/usr/bin/generate-quill-docs.sh
+++ /dev/null
@@ -1,56 +0,0 @@
-#!/bin/bash
-
-#
-# This script will generate bash documentation (for as far as it has been
made
-# available in the code) from Quill.
-#
-BIN=/usr/bin
-DOCDIR=/usr/share/doc/quill/htmldocs
-BASHDOC=$BIN/bashdoc.sh
-FLOW=$BIN/flow.sh
-SRC2HTML=$BIN/src2html.sh
-PROJECT=Quill
-
-QUIET=${QUIET:--q -q}
-
-SCRIPTS="/var/lib/quill/modules/lib* /var/lib/quill/modules/site_handlers/* \
-/usr/bin/quill"
-#exclude non-sorcery files, like backups~ or numbered versions
-for FILE in $SCRIPTS
-do
- if grep -q "[0-9]" <<< $FILE; then
- if grep -Eq "(libgcc2|api[12])" <<< $FILE; then
- SCRIPTS2="$SCRIPTS2 $FILE"
- fi
- elif grep -q '~' <<< $FILE; then
- true
- else
- SCRIPTS2="$SCRIPTS2 $FILE"
- fi
-done
-SCRIPTS="$SCRIPTS2"
-
-# make the bashdoc dir
-if [ -d $DOCDIR ] ; then
- rm -rf $DOCDIR
- mkdir -p $DOCDIR
-else
- mkdir -p $DOCDIR
-fi
-
-# generate docs for libs
-if [ -x "$BASHDOC" ] ; then
- $BASHDOC ${QUIET} -p $PROJECT -o $DOCDIR $SCRIPTS
-else
- echo "The bashdoc tools are not installed, please cast bashdoc!"
-fi
-
-${SRC2HTML} --funcs $DOCDIR $SCRIPTS
-if which dot >/dev/null 2>&1 ; then
- ${FLOW} --funcs $DOCDIR --exclude debug --exclude query \
- --exclude message --exclude error_msg $SCRIPTS
-else
- echo "No graphviz found, not generating images."
-fi
-
-# end
diff --git a/var/lib/quill/ChangeLog b/var/lib/quill/ChangeLog
index eb20d9a..f7157bf 100644
--- a/var/lib/quill/ChangeLog
+++ b/var/lib/quill/ChangeLog
@@ -1,3 +1,12 @@
+2010-08-13 Bor Kraljič <pyrobor AT ver.si>
+ * lib*, quill: fixed functions headers to work with bashdoc
+ * libupdate: sort the files in file_menu so they are easier to
+ find (bug #15432)
+ * generate-quill-docs.sh: script to generate html doc pages
+
+2010-06-29 Bor Kraljič <pyrobor AT ver.si>
+ * quill: re-source DETAILS after fixing WEB_SITE (bug #15754)
+
2009-08-29 Jaka Kranjc <lynxlynxlynx AT sourcemage.org>
* libcompat: added a modified version of real_query_string,
now you can delete also the first char when asked to enter text
diff --git a/var/lib/quill/modules/libcompat b/var/lib/quill/modules/libcompat
index a5dab3a..0327284 100644
--- a/var/lib/quill/modules/libcompat
+++ b/var/lib/quill/modules/libcompat
@@ -96,7 +96,7 @@ function select_list_sub() {

unset -f url_https_verify &&
#---
-##
+## @param url to verifiy
#---
function url_https_verify() {
local URL=$1
diff --git a/var/lib/quill/modules/libcore b/var/lib/quill/modules/libcore
index 774a28d..990942f 100644
--- a/var/lib/quill/modules/libcore
+++ b/var/lib/quill/modules/libcore
@@ -5,10 +5,10 @@

#---
## @Synopsis query_list function from init-manager
-## $1 - the question
-## $2 - the VARIABLE to which to store the answer
-## $3 - the default answer
-## $4...$n - the options for the list
+## @param the question
+## @param the VARIABLE to which to store the answer
+## @param the default answer
+## @param ...$n - the options for the list
##
## @Globals none
#---
@@ -23,8 +23,8 @@ function query_list()
#---
## @Synopsis an elaborate version of query for the quad option list
## Skips the query if the default/saved answer is yes or no
-## $1 - the question
-## $2 - the contents of the variable with the default answer
+## @param the question
+## @param the contents of the variable with the default answer
##
## @Globals none
#---
@@ -193,6 +193,7 @@ function quill_welcome() {

#---
## @Synopsis used to edit spell files
+## @param spell file to edit
##
## @Globals EDITOR QUILL_SPELL_DIR SPELL_NAME
#---
@@ -389,7 +390,7 @@ function check_source_urls() {
}

#---
-## @Synopsis dumps the default spell file function, taking into
+## dumps the default spell file function, taking into
## account that devel has a new spell file inheritance scheme
##
## @Globals none
@@ -455,8 +456,8 @@ function dir_check() {
}

#---
-## @Synopsis adds && to all full lines not already ending with &&, \
-## @Synopsis or being the last line
+## adds && to all full lines not already ending with &&,
+## or being the last line
##
## @Globals none
#---
@@ -472,6 +473,7 @@ function andand_lines() {

#---
## @Synopsis cleans out various special chars from html
+## @param file to clean
##
## @Globals QUILL_MODULES
#---
@@ -539,8 +541,6 @@ function unset_spell_paths(){
#---
## @Synopsis checks if anything needs summoning and does so
##
-## @param none
-##
## @Globals "sources" "sources_and_urls"
#---
function summon_sources() {
@@ -605,6 +605,7 @@ function inc_src_num() {

#---
## @Synopsis prints a colored error message
+## @param error message
##
## @Globals none
#---
@@ -614,6 +615,7 @@ function error_msg() {

#---
## @Synopsis prints a colored query message
+## @param query message
##
## @Globals none
#---
diff --git a/var/lib/quill/modules/libdeprecation
b/var/lib/quill/modules/libdeprecation
index abc45df..ca68451 100644
--- a/var/lib/quill/modules/libdeprecation
+++ b/var/lib/quill/modules/libdeprecation
@@ -159,6 +159,7 @@ function get_replacement() {

#---
## plain deletes a spell, can't really work
+## @param reason
#---
function delete_spell() {
local reason=$1
diff --git a/var/lib/quill/modules/libdetails
b/var/lib/quill/modules/libdetails
index a3b9a47..dd6ff13 100644
--- a/var/lib/quill/modules/libdetails
+++ b/var/lib/quill/modules/libdetails
@@ -6,6 +6,7 @@
#---

#---
+## Check if the spell name is proper and downcase it
##
## @Globals SPELL_NAME
#---
diff --git a/var/lib/quill/modules/site_handlers/libhackagedb
b/var/lib/quill/modules/site_handlers/libhackagedb
index ede87d0..31c6a72 100644
--- a/var/lib/quill/modules/site_handlers/libhackagedb
+++ b/var/lib/quill/modules/site_handlers/libhackagedb
@@ -5,6 +5,9 @@


#---
+## @param package
+## @param package page
+## @param cabal file
## @Globals none
#---
function quill_hdb_get_files(){
@@ -41,6 +44,8 @@ function quill_hdb_get_files(){
}

#---
+## @param info
+## @param file
## @Globals none
#---
function quill_hdb_get_info(){
@@ -80,6 +85,8 @@ function quill_hdb_get_info(){
}

#---
+## @param spell name
+## @param package
## @Globals SPELL_NAME QUILL_TMP_DIR SPELL_LICENSE
## @Globals SPELL_SHORT_DESCRIPTION SPELL_DESC_NAME
## @Globals SPELL_URL SPELL_SRC_URL SPELL_DEPENDENCIES



  • [SM-Commit] GIT changes to master quill by Bor Kraljič (99c8fb76d75c30ca981e12a6fe0c306da9a3eeff), Bor Kraljič, 08/13/2010

Archive powered by MHonArc 2.6.24.

Top of Page