Changeset 12

Timestamp:

10/21/15 12:23:59 (9 years ago)

Author:

pinsard

Message:

describe how to check typo on source files

Location:

trunk/docs/manual/source/developers/guides

Files:

• typo.rst (modified) (7 diffs)
• typo_blockdiag.dot (modified) (previous)

trunk/docs/manual/source/developers/guides/typo.rst

@@ -11 +11 @@
 :command:`pylint` can also be used for Python source.
 
-They use dictionaries providing natural langages list of words.
+They use dictionaries providing natural languages list of words.
 
 Here is the flow
@@ -21 +21 @@
 
 System dictionaries lack some scientific words (ex barocline),
-computer langages reserved words, acronyms (ex. IGCMG) and
+computer languages reserved words, acronyms (ex. IGCMG) and
 code variables names.
 
@@ -108 +108 @@
    sed -e "s@^@http://forge.ipsl.jussieu.fr@" > ${list_href}
    trac_uri=${PROJECT_LOG}/trac_uri
-   sed -e "s@^@http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/@"  ${PROJECT}/docs/manual/for_tracwiki/tracpages.txt  sort -u > ${trac_uri}
+   sed -e "s@^@http://forge.ipsl.jussieu.fr/igcmg_doc/wiki/@"  ${PROJECT}/docs/manual/for_tracwiki/tracpages.txt | sort -u > ${trac_uri}
    list_uri=$(comm  -13 ${trac_uri} ${list_href})
 
@@ -148 +148 @@
 
 - typo to be fixed in wiki pages
-- false positif to be added in a :file:`docs/manual/for_typo/`
-- false positif to be ignored because too hard to add (encoding issue for
+- false positive to be added in a :file:`docs/manual/for_typo/`
+- false positive to be ignored because too hard to add (encoding issue for
   Greek word, etc.)
 
@@ -176 +176 @@
 
    It is also possible to find wrong spelling via the search facility
-   on the trac interface but resultats may differ (case sensitivity,
+   on the trac interface but results may differ (case sensitivity,
    trac plugins)
 
@@ -245 +245 @@
 
 - typo to be fixed in PDF files
-- false positif to be added in a :file:`docs/manual/for_typo/`
-- false positif to be ignored because bad convertion from PDF to text
+- false positive to be added in a :file:`docs/manual/for_typo/`
+- false positive to be ignored because bad conversion from PDF to text
   (ie ligature), too hard to add (encoding issue for Greek word, etc.)
 
@@ -255 +255 @@
    w=infrastucture # take a real one from ${hunspell_out_uniq}
    find ${dirpdf} -type f -name "*.pdf.txt" -exec grep -Hi ${w} {} \;
+
+Check typo in :file:`libIGCM` source files
+++++++++++++++++++++++++++++++++++++++++++
+
+Assuming modipsl has been downloaded following 
+https://forge.ipsl.jussieu.fr/igcmg_doc/wiki/DocCinstall#Description
+in :envvar:`MODIPSL`.
+
+We can check typo in source files
+
+.. code-block:: bash
+
+   cd ${PROJECT_LOG}
+   listf=$(find ${MODIPSL} -path '*/.svn' -prune -o -type f)
+   hunspell_out=${PROJECT_LOG}/hunspell_out
+   hunspell_out_uniq=${PROJECT_LOG}/hunspell_out_uniq
+   rm -f ${hunspell_out}  ${hunspell_out_uniq}
+   for onefile in ${listf}
+   do
+      LC_ALL=C;hunspell -d en_US,nontypo_uniq --check-url -i utf-8 -l < ${onefile} >> ${hunspell_out}
+   done
+   sort -u ${hunspell_out} | sort --ignore-case > ${hunspell_out_uniq}
+
+:file:`${hunspell_out_uniq}` contains :
+
+- typo to be fixed in source files
+- false positive to be added in a :file:`docs/manual/for_typo/`
+- false positive to be ignored because encoding issue
+
+To find one of the wrong spelling in sources files:
+
+.. code-block:: bash
+
+   w=destionation # take a real one from ${hunspell_out_uniq}
+   find ${MODIPSL} -path '*/.svn' -prune -o -type f -exec grep -Hi ${w} {} \;
+
+.. warning::
+
+   Correction have to be done in working space and committed