From b1ab3e2aefca2dd0b7850fa23d88bfc5f9a98490 Mon Sep 17 00:00:00 2001 From: Chris Koeritz Date: Mon, 12 Dec 2016 07:10:56 -0500 Subject: [PATCH] tasty renamings moved doc to documentation and fixed all references ( i hope ). moved customizing to customize and fixed all refs ( ditto ). added nice docs to doxygen docs builder for error case. --- .../fred/fred_common.alias | 0 .../fred/fred_variables.sh | 2 +- .../fred/java_profile.sh | 0 {customizing => customize}/fred/refred.sh | 0 .../fred/scripts/gamesaver.sh | 0 .../fred/scripts/pick_credentials.sh | 0 .../fred/scripts/sftp.sh | 0 .../fred/scripts/ssh.sh | 0 .../fred/scripts/synch_archives_from_surya.sh | 0 .../fred/scripts/update_barkuptree.sh | 0 .../fred/scripts/update_musix_on_curie.sh | 0 .../fred/scripts/update_soapbox.sh | 0 .../how_to_customize.txt | 0 {customizing => customize}/mik/mik.alias | 0 doc/makefile | 17 ------------ .../clam_manual/clam_docs.html | 0 .../clam_manual/clam_root.html | 0 .../cygwin_install_list.txt | 0 .../doc_fodder/bash_tools.html | 0 .../doc_fodder/perl_tools.html | 0 {doc => documentation}/doc_fodder/readme.txt | 0 documentation/doxygen_objdb_22847.tmp | 0 {doc => documentation}/feisty_meow_dox.config | 0 .../headers/fmc_header.java | 0 {doc => documentation}/headers/gnu_header.h | 0 .../headers/shell_header.txt | 0 .../headers/uva_header.java | 0 {doc => documentation}/history_anat.txt | 6 ++--- documentation/makefile | 27 +++++++++++++++++++ .../text_examples/chinese_simplified_text.txt | 0 .../text_examples/korean_text.txt | 0 .../text_examples/readme.txt | 0 .../text_examples/russian_text.txt | 0 .../text_examples/tibetan_text.txt | 0 infobase/configuration/cron/doxygen.crontab | 2 ++ .../whole_build_manifest.txt | 12 ++++----- readme.txt | 4 +-- scripts/archival/snarf_feisty_meow.pl | 4 +-- scripts/core/functions.sh | 12 ++++----- 39 files changed, 49 insertions(+), 37 deletions(-) rename {customizing => customize}/fred/fred_common.alias (100%) rename {customizing => customize}/fred/fred_variables.sh (97%) rename {customizing => customize}/fred/java_profile.sh (100%) rename {customizing => customize}/fred/refred.sh (100%) rename {customizing => customize}/fred/scripts/gamesaver.sh (100%) rename {customizing => customize}/fred/scripts/pick_credentials.sh (100%) rename {customizing => customize}/fred/scripts/sftp.sh (100%) rename {customizing => customize}/fred/scripts/ssh.sh (100%) rename {customizing => customize}/fred/scripts/synch_archives_from_surya.sh (100%) rename {customizing => customize}/fred/scripts/update_barkuptree.sh (100%) rename {customizing => customize}/fred/scripts/update_musix_on_curie.sh (100%) rename {customizing => customize}/fred/scripts/update_soapbox.sh (100%) rename {customizing => customize}/how_to_customize.txt (100%) rename {customizing => customize}/mik/mik.alias (100%) delete mode 100644 doc/makefile rename {doc => documentation}/clam_manual/clam_docs.html (100%) rename {doc => documentation}/clam_manual/clam_root.html (100%) rename {doc => documentation}/cygwin_install_list.txt (100%) rename {doc => documentation}/doc_fodder/bash_tools.html (100%) rename {doc => documentation}/doc_fodder/perl_tools.html (100%) rename {doc => documentation}/doc_fodder/readme.txt (100%) create mode 100644 documentation/doxygen_objdb_22847.tmp rename {doc => documentation}/feisty_meow_dox.config (100%) rename {doc => documentation}/headers/fmc_header.java (100%) rename {doc => documentation}/headers/gnu_header.h (100%) rename {doc => documentation}/headers/shell_header.txt (100%) rename {doc => documentation}/headers/uva_header.java (100%) rename {doc => documentation}/history_anat.txt (96%) create mode 100644 documentation/makefile rename {doc => documentation}/text_examples/chinese_simplified_text.txt (100%) rename {doc => documentation}/text_examples/korean_text.txt (100%) rename {doc => documentation}/text_examples/readme.txt (100%) rename {doc => documentation}/text_examples/russian_text.txt (100%) rename {doc => documentation}/text_examples/tibetan_text.txt (100%) diff --git a/customizing/fred/fred_common.alias b/customize/fred/fred_common.alias similarity index 100% rename from customizing/fred/fred_common.alias rename to customize/fred/fred_common.alias diff --git a/customizing/fred/fred_variables.sh b/customize/fred/fred_variables.sh similarity index 97% rename from customizing/fred/fred_variables.sh rename to customize/fred/fred_variables.sh index 6392c2ec..86c29b96 100644 --- a/customizing/fred/fred_variables.sh +++ b/customize/fred/fred_variables.sh @@ -17,7 +17,7 @@ if [ -z "$USER_CUSTOMIZATIONS_LOADED" ]; then # add a bunch of folders to the list for checkin & checkout. these are # definitely personal, and some of them are fairly dated (the yeti and # hoople folders, for example). - REPOSITORY_LIST+="cloud ebooks web antique inova_codebase antique/inova_codebase yeti bigdata gffs/docs gffs/secrets gffs/code/fred-trunk " + REPOSITORY_LIST+="cloud ebooks web antique inova_codebase antique/inova_codebase yeti bigdata " # point to our local certificate for ssh usage. export SVN_SSH="ssh -i $HOME/.ssh/id_dsa_sourceforge" diff --git a/customizing/fred/java_profile.sh b/customize/fred/java_profile.sh similarity index 100% rename from customizing/fred/java_profile.sh rename to customize/fred/java_profile.sh diff --git a/customizing/fred/refred.sh b/customize/fred/refred.sh similarity index 100% rename from customizing/fred/refred.sh rename to customize/fred/refred.sh diff --git a/customizing/fred/scripts/gamesaver.sh b/customize/fred/scripts/gamesaver.sh similarity index 100% rename from customizing/fred/scripts/gamesaver.sh rename to customize/fred/scripts/gamesaver.sh diff --git a/customizing/fred/scripts/pick_credentials.sh b/customize/fred/scripts/pick_credentials.sh similarity index 100% rename from customizing/fred/scripts/pick_credentials.sh rename to customize/fred/scripts/pick_credentials.sh diff --git a/customizing/fred/scripts/sftp.sh b/customize/fred/scripts/sftp.sh similarity index 100% rename from customizing/fred/scripts/sftp.sh rename to customize/fred/scripts/sftp.sh diff --git a/customizing/fred/scripts/ssh.sh b/customize/fred/scripts/ssh.sh similarity index 100% rename from customizing/fred/scripts/ssh.sh rename to customize/fred/scripts/ssh.sh diff --git a/customizing/fred/scripts/synch_archives_from_surya.sh b/customize/fred/scripts/synch_archives_from_surya.sh similarity index 100% rename from customizing/fred/scripts/synch_archives_from_surya.sh rename to customize/fred/scripts/synch_archives_from_surya.sh diff --git a/customizing/fred/scripts/update_barkuptree.sh b/customize/fred/scripts/update_barkuptree.sh similarity index 100% rename from customizing/fred/scripts/update_barkuptree.sh rename to customize/fred/scripts/update_barkuptree.sh diff --git a/customizing/fred/scripts/update_musix_on_curie.sh b/customize/fred/scripts/update_musix_on_curie.sh similarity index 100% rename from customizing/fred/scripts/update_musix_on_curie.sh rename to customize/fred/scripts/update_musix_on_curie.sh diff --git a/customizing/fred/scripts/update_soapbox.sh b/customize/fred/scripts/update_soapbox.sh similarity index 100% rename from customizing/fred/scripts/update_soapbox.sh rename to customize/fred/scripts/update_soapbox.sh diff --git a/customizing/how_to_customize.txt b/customize/how_to_customize.txt similarity index 100% rename from customizing/how_to_customize.txt rename to customize/how_to_customize.txt diff --git a/customizing/mik/mik.alias b/customize/mik/mik.alias similarity index 100% rename from customizing/mik/mik.alias rename to customize/mik/mik.alias diff --git a/doc/makefile b/doc/makefile deleted file mode 100644 index 88ed4167..00000000 --- a/doc/makefile +++ /dev/null @@ -1,17 +0,0 @@ - -export DEFINITIONS - # ensure that the macros get passed down to the subprocesses. - -include cpp/variables.def - -PROJECT = Source_Documentation -TYPE = application -FIRST_TARGETS += build_doxygen -CLEANUPS += html - -include cpp/rules.def - -build_doxygen: - @echo the defs are $(DEFINITIONS) - doxygen $(wildcard *.config) - diff --git a/doc/clam_manual/clam_docs.html b/documentation/clam_manual/clam_docs.html similarity index 100% rename from doc/clam_manual/clam_docs.html rename to documentation/clam_manual/clam_docs.html diff --git a/doc/clam_manual/clam_root.html b/documentation/clam_manual/clam_root.html similarity index 100% rename from doc/clam_manual/clam_root.html rename to documentation/clam_manual/clam_root.html diff --git a/doc/cygwin_install_list.txt b/documentation/cygwin_install_list.txt similarity index 100% rename from doc/cygwin_install_list.txt rename to documentation/cygwin_install_list.txt diff --git a/doc/doc_fodder/bash_tools.html b/documentation/doc_fodder/bash_tools.html similarity index 100% rename from doc/doc_fodder/bash_tools.html rename to documentation/doc_fodder/bash_tools.html diff --git a/doc/doc_fodder/perl_tools.html b/documentation/doc_fodder/perl_tools.html similarity index 100% rename from doc/doc_fodder/perl_tools.html rename to documentation/doc_fodder/perl_tools.html diff --git a/doc/doc_fodder/readme.txt b/documentation/doc_fodder/readme.txt similarity index 100% rename from doc/doc_fodder/readme.txt rename to documentation/doc_fodder/readme.txt diff --git a/documentation/doxygen_objdb_22847.tmp b/documentation/doxygen_objdb_22847.tmp new file mode 100644 index 00000000..e69de29b diff --git a/doc/feisty_meow_dox.config b/documentation/feisty_meow_dox.config similarity index 100% rename from doc/feisty_meow_dox.config rename to documentation/feisty_meow_dox.config diff --git a/doc/headers/fmc_header.java b/documentation/headers/fmc_header.java similarity index 100% rename from doc/headers/fmc_header.java rename to documentation/headers/fmc_header.java diff --git a/doc/headers/gnu_header.h b/documentation/headers/gnu_header.h similarity index 100% rename from doc/headers/gnu_header.h rename to documentation/headers/gnu_header.h diff --git a/doc/headers/shell_header.txt b/documentation/headers/shell_header.txt similarity index 100% rename from doc/headers/shell_header.txt rename to documentation/headers/shell_header.txt diff --git a/doc/headers/uva_header.java b/documentation/headers/uva_header.java similarity index 100% rename from doc/headers/uva_header.java rename to documentation/headers/uva_header.java diff --git a/doc/history_anat.txt b/documentation/history_anat.txt similarity index 96% rename from doc/history_anat.txt rename to documentation/history_anat.txt index f6e49188..9bf86e8e 100644 --- a/doc/history_anat.txt +++ b/documentation/history_anat.txt @@ -78,9 +78,9 @@ database/ Some files considered critical to the operations of Feisty Meow Concerns Ltd. This includes the database of fortunes used by the Nechung Oracle Program. -doc/ - Assorted documentation files for Feisty Meow and a code-scanning documentation generator - based on doxygen. +documentation/ + Helpful guides and information for Feisty Meow. Also includes a code documentation generator + configuration for feisty meow that produces a nice set of web docs, using doxygen. examples/ Some files that show how to get work done with Feisty Meow or that show how to do certain diff --git a/documentation/makefile b/documentation/makefile new file mode 100644 index 00000000..30fa8229 --- /dev/null +++ b/documentation/makefile @@ -0,0 +1,27 @@ + +export DEFINITIONS + # ensure that the macros get passed down to the subprocesses. + +include cpp/variables.def + +PROJECT = Source_Documentation +TYPE = application +FIRST_TARGETS += build_doxygen +CLEANUPS += html + +include cpp/rules.def + +build_doxygen: + @echo the defs are $(DEFINITIONS) + $(HIDESH) -c '\ +doxygen $(wildcard *.config); \ +if [ $$? -ne 0 ]; then \ + echo failed to run doxygen on our configuration file.; \ + echo perhaps it is not installed?; \ + echo these are the ubuntu install steps:; \ + echo sudo apt-get install doxygen graphviz; \ +echo and something else, uhhh....; \ +echo oy; \ +fi \ +' + diff --git a/doc/text_examples/chinese_simplified_text.txt b/documentation/text_examples/chinese_simplified_text.txt similarity index 100% rename from doc/text_examples/chinese_simplified_text.txt rename to documentation/text_examples/chinese_simplified_text.txt diff --git a/doc/text_examples/korean_text.txt b/documentation/text_examples/korean_text.txt similarity index 100% rename from doc/text_examples/korean_text.txt rename to documentation/text_examples/korean_text.txt diff --git a/doc/text_examples/readme.txt b/documentation/text_examples/readme.txt similarity index 100% rename from doc/text_examples/readme.txt rename to documentation/text_examples/readme.txt diff --git a/doc/text_examples/russian_text.txt b/documentation/text_examples/russian_text.txt similarity index 100% rename from doc/text_examples/russian_text.txt rename to documentation/text_examples/russian_text.txt diff --git a/doc/text_examples/tibetan_text.txt b/documentation/text_examples/tibetan_text.txt similarity index 100% rename from doc/text_examples/tibetan_text.txt rename to documentation/text_examples/tibetan_text.txt diff --git a/infobase/configuration/cron/doxygen.crontab b/infobase/configuration/cron/doxygen.crontab index 4ea575e5..48016ecc 100644 --- a/infobase/configuration/cron/doxygen.crontab +++ b/infobase/configuration/cron/doxygen.crontab @@ -5,6 +5,8 @@ SHELL=/bin/bash USER=fred +# this is out of date! + #[doxygen] 20 4 * * * (source $HOME/feisty_meow/scripts/core/launch_feisty_meow.sh; cd $HOME/hoople/docs; make) &>>/tmp/zz_doxy_make_$USER.log diff --git a/production/setup_src/whole_build_package/whole_build_manifest.txt b/production/setup_src/whole_build_package/whole_build_manifest.txt index 8100faa6..40423314 100644 --- a/production/setup_src/whole_build_package/whole_build_manifest.txt +++ b/production/setup_src/whole_build_package/whole_build_manifest.txt @@ -8,7 +8,7 @@ production_inis=t docs=t top_makefile=t production_makefile=t -customizing=t +customize=t database=t examples=t scripts=t @@ -64,9 +64,9 @@ source=$PRODUCTION_STORE/makefile target=$TARGET/production/makefile keyword=sources -[customizing] -source=$FEISTY_MEOW_APEX/customizing -target=$TARGET/customizing +[customize] +source=$FEISTY_MEOW_APEX/customize +target=$TARGET/customize recurse=1 keyword=sources @@ -77,8 +77,8 @@ recurse=1 keyword=sources [docs] -source=$FEISTY_MEOW_APEX/doc -target=$TARGET/doc +source=$FEISTY_MEOW_APEX/documentation +target=$TARGET/documentation recurse=1 keyword=sources diff --git a/readme.txt b/readme.txt index d5cd8d7f..fd06924f 100644 --- a/readme.txt +++ b/readme.txt @@ -9,7 +9,7 @@ conditional portions are prefixed with a '|' character.) How to get the feisty meow codebase | On Microsoft Windows, install the Cygwin tools as documented here: -| ~/feisty_meow/doc/cygwin_install_list.txt +| ~/feisty_meow/documentation/cygwin_install_list.txt Retrieve a clone of the feisty meow code: => git clone git://feistymeow.org/feisty_meow @@ -53,7 +53,7 @@ How to install the build dependencies for feisty meow | Microsoft Windows: | Download and install the Cygwin environment first from cygwin.com, which is -| documented in ~/feisty_meow/doc/cygwin_install_list.txt +| documented in ~/feisty_meow/documentation/cygwin_install_list.txt ============== How to build the feisty meow codebase diff --git a/scripts/archival/snarf_feisty_meow.pl b/scripts/archival/snarf_feisty_meow.pl index c532dddb..fd9192e7 100644 --- a/scripts/archival/snarf_feisty_meow.pl +++ b/scripts/archival/snarf_feisty_meow.pl @@ -39,9 +39,9 @@ local($root) = &canonicalize("$HOME/feisty_meow"); # snarf up all the important directories. # CAK: current as of 2012-05-05. -&backup_hierarchy($snarf_file_base, $number, $root, "customizing"); +&backup_hierarchy($snarf_file_base, $number, $root, "customize"); &backup_hierarchy($snarf_file_base, $number, $root, "infobase"); -&backup_hierarchy($snarf_file_base, $number, $root, "doc"); +&backup_hierarchy($snarf_file_base, $number, $root, "documentation"); &backup_hierarchy($snarf_file_base, $number, $root, "examples"); &backup_hierarchy($snarf_file_base, $number, $root, "feisty_inits"); &backup_hierarchy($snarf_file_base, $number, $root, "graphiq"); diff --git a/scripts/core/functions.sh b/scripts/core/functions.sh index 65aa9410..94591263 100644 --- a/scripts/core/functions.sh +++ b/scripts/core/functions.sh @@ -376,15 +376,15 @@ if [ -z "$skip_all" ]; then # use our default example user if there was no name provided. user=fred fi - if [ ! -d "$FEISTY_MEOW_APEX/customizing/$user" ]; then + if [ ! -d "$FEISTY_MEOW_APEX/customize/$user" ]; then echo "The customization folder provided for $user should be:" - echo " '$FEISTY_MEOW_APEX/customizing/$user'" + echo " '$FEISTY_MEOW_APEX/customize/$user'" echo "but that folder does not exist. Skipping customization." return 1 fi regenerate >/dev/null pushd "$FEISTY_MEOW_LOADING_DOCK/custom" &>/dev/null - incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")" + incongruous_files="$(bash "$FEISTY_MEOW_SCRIPTS/files/list_non_dupes.sh" "$FEISTY_MEOW_APEX/customize/$user" "$FEISTY_MEOW_LOADING_DOCK/custom")" #echo "the incongruous files list is: $incongruous_files" # disallow a single character result, since we get "*" as result when nothing exists yet. @@ -396,10 +396,10 @@ if [ -z "$skip_all" ]; then popd &>/dev/null echo "copying custom overrides for $user" mkdir -p "$FEISTY_MEOW_LOADING_DOCK/custom" 2>/dev/null - perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customizing/$user" "$FEISTY_MEOW_LOADING_DOCK/custom" - if [ -d "$FEISTY_MEOW_APEX/customizing/$user/scripts" ]; then + perl "$FEISTY_MEOW_SCRIPTS/text/cpdiff.pl" "$FEISTY_MEOW_APEX/customize/$user" "$FEISTY_MEOW_LOADING_DOCK/custom" + if [ -d "$FEISTY_MEOW_APEX/customize/$user/scripts" ]; then echo "copying custom scripts for $user" - \cp -R "$FEISTY_MEOW_APEX/customizing/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" + \cp -R "$FEISTY_MEOW_APEX/customize/$user/scripts" "$FEISTY_MEOW_LOADING_DOCK/custom/" fi echo regenerate -- 2.34.1