[Lsb-messages] /var/www/bzr/lsb/devel/specdb-aux-scripts r15: README cleanup and rename on script (spelling)

Mats Wichmann mats at linuxfoundation.org
Fri Mar 1 14:50:01 UTC 2013


------------------------------------------------------------
revno: 15
committer: Mats Wichmann <mats at linuxfoundation.org>
branch nick: specdb-aux-scripts
timestamp: Fri 2013-03-01 07:50:01 -0700
message:
  README cleanup and rename on script (spelling)
renamed:
  appearence_checker.sh => appearance_checker.sh
  appearence_fields => appearance_fields
modified:
  README
  check_consistency.sh
  appearance_checker.sh
-------------- next part --------------
=== modified file 'README'
--- a/README	2008-12-23 11:39:12 +0000
+++ b/README	2013-03-01 14:50:01 +0000
@@ -3,50 +3,64 @@
 
 1. check_consistency.sh
 ========================
-This script perform foreign keys check and some tricky consistency checks driven by data semantics.
-New checkes can be easily added to that script - one should simply call 'call_check' with
-nesessary SQL statement and appropriate comment (see the script for examples - they are rather straightforward).
+This script performs a foreign keys check and some tricky consistency
+checks driven by data semantics.  New checke can be easily added to
+the script - simply call 'call_check' with nesessary SQL statement
+and appropriate comment (see the script for examples - they are rather
+straightforward).
 
-Foreign keys are not supported by MyISAM, so it is impossible to force MySQL to check them.
-LSB DB foreign keys are stored in the 'foreign_keys' file, on key per line, in the following format:
+Foreign keys are not supported by MyISAM, so it is impossible to force
+MySQL to check them.  LSB DB foreign keys are stored in the 'foreign_keys'
+file, on key per line, in the following format:
 
 <Key_Table> <Key_Field> <Ref_Table> <Ref_Field>
 
 2. url_checker.sh
 ==================
-This script checks urls for interfaces. Pages downloaded during testing process are saved in the 'downloaded pages' folder
-with subfolders hierarchy matching the full downloaded url. The script tries to download target page using wget, and
-if url contains an anchor, then the page is grepped for that anchor.
+This script checks urls for interfaces. Pages downloaded during the
+testing process are saved in the 'downloaded_pages' folder with a
+subfolder hierarchy matching the full downloaded url. The script tries
+to download the target page using wget, and if url contains an anchor,
+then the page is grepped for that anchor.
 
-Note: the 'downloaded pages' folder content is dropped automatically when url_checker.sh starts.
+Note: the 'downloaded_pages' folder content is dropped automatically
+when url_checker.sh starts.
 
 Issues:
-* anchors in the 'Itanium C++ ABI' document are ignored at the moment, since that document has incorrect layout
+* anchors in the 'Itanium C++ ABI' document are ignored at the moment,
+  since that document has incorrect layout
 * arch-specific LSB urls are not checked
 
-3. appearence_checker.sh
+3. appearance_checker.sh
 ========================
-This script checks consistency of 'appearence' information in different tables relative to the same entity.
-For example, for interfaces we have 'appearence' fields in the ArchInt and IntStd tables; if the symbols is included
-in some LSB version according to the ArchInt data, then it should be included in that version according to the IntStd data,
-and vise verca.
-
-Another example is Interface<->Header relationship; if the interface is included in some LSB version, then its header should
-be also included in the same version, but inclusion of a header doesn't imply inclusion of all its interfaces.
-
-appearence_checker.sh uses appearence_fields file to get information about the fields it should check.
-Every line of the file should contain four space-separated values:
+This script checks the consistency of 'appearance' information in
+different tables relative to the same entity.  For example, for interfaces
+we have 'appearedin' and 'withdrawnin' fields in the ArchInt and IntStd
+tables; if the symbol is included in some LSB version according to the
+ArchInt data, then it should be included in that version according to
+the IntStd data, and vise versa.
+
+Another example is Interface<->Header relationship; if the interface is
+included in some LSB version, then its header should be also included
+in the same version, but inclusion of a header doesn't imply inclusion
+of all its interfaces.
+
+appearance_checker.sh uses the appearance_fields file to get information
+about the fields it should check.  Every line of the file should contain
+four space-separated values:
 
 Table1 Field1 Table2 Field2
 
-This record is treats like the following: if some value of Table1.Field1 is marked as included in LSX X, then
-there should be an entry in the Table2 with Field2=Table1.Field1 which is also included in LSB X.
-Names of appearence fields are calculated automatically on the basis of the tables names.
+This record is treated as follows: if some value of Table1.Field1 is
+marked as included in LSX X, then there should be an entry in the Table2
+with Field2=Table1.Field1 which is also included in LSB X.  Names of
+appearance fields are calculated automatically on the basis of the
+tables names.
 
-Note that it is possible to specify any SQL statement as a first table, you should simply replace all spaces with
-underscores, i.e.
+Note that it is possible to specify any SQL statement as a first table,
+you should simply replace all spaces with underscores, i.e.
 
 ArchInt_join_Interface_on_Iid=AIint_and_Iheader>0 Iheader Header Hid
 
-The only restriction is that the first word (between the first underscore) should be the table which actually 
-contains 'appearence' fields.
+The only restriction is that the first word (between the first underscore)
+should be the table which actually contains 'appearedin' fields.

=== renamed file 'appearence_checker.sh' => 'appearance_checker.sh'
--- a/appearence_checker.sh	2010-10-22 09:57:27 +0000
+++ b/appearance_checker.sh	2013-03-01 14:50:01 +0000
@@ -7,9 +7,9 @@
 
 MAX_LSB_VERSION=`mysql $LSBDB -u $LSBUSER $passwd_option -e "SELECT MAX(LVvalue) FROM LSBVersion" | grep -v MAX`
 
-echo > appearence_check.out
+echo > appearance_check.out
 
-cat appearence_fields | while read table1 id_field1 table2 id_field2
+cat appearance_fields | while read table1 id_field1 table2 id_field2
 do
 	table1_clear=`echo $table1 | cut -f1 -d_`
 	table1_joins=`echo $table1 | cut -f2- -d_ | sed s/_/\ /g`
@@ -50,10 +50,10 @@
 				    AND ($field_withdrawn2 IS NULL OR $field_withdrawn2 > '$version') LIMIT 1" | grep -v $id_field2`
 			if [[ $detect != $table_id ]]
 			then
-				echo "Appearence: $table1.$id_field1 = $table_id is marked as included in LSB $version, but $table2 doesn't have appropriate record for $id_field2" >> appearence_check.out
+				echo "Appearance: $table1.$id_field1 = $table_id is marked as included in LSB $version, but $table2 doesn't have appropriate record for $id_field2" >> appearance_check.out
 			fi
 		done
 	done
 done
 
-sort -u appearence_check.out > appearence_check.out.tmp && mv appearence_check.out.tmp appearence_check.out
+sort -u appearance_check.out > appearance_check.out.tmp && mv appearance_check.out.tmp appearance_check.out

=== renamed file 'appearence_fields' => 'appearance_fields'
=== modified file 'check_consistency.sh'
--- a/check_consistency.sh	2009-03-13 09:56:07 +0000
+++ b/check_consistency.sh	2013-03-01 14:50:01 +0000
@@ -1,6 +1,6 @@
 #!/bin/sh
 
-#######################################################################################
+################################################################################
 # Set of LSB SpecDB consistency checks.
 #
 # NOTE: These checks don't duplicate LSB Navigator 'DB Consistency' section
@@ -9,7 +9,7 @@
 # Copyright 2008 Institute for System Programming, RAS
 #
 # Author: Denis Silakov <silakov at ispras.ru>
-#######################################################################################
+################################################################################
 
 dump_all=0 # Do we want to log all queries? 
 	   # By default only those that found some inconsistencies are logged



More information about the lsb-messages mailing list