Add the OpenFOAM source tree
This commit is contained in:
15
doc/tools/README
Normal file
15
doc/tools/README
Normal file
@ -0,0 +1,15 @@
|
||||
Misc. tools for finding and/or repairing common documentation problems
|
||||
See the comments in the scripts.
|
||||
|
||||
1. find-suspiciousTags
|
||||
2. fix-Class
|
||||
3. find-tinyDescription
|
||||
4. find-placeholderDescription
|
||||
5. find-retagged
|
||||
|
||||
Misc Tools
|
||||
1. find-templateInComments
|
||||
2. find-its
|
||||
3. find-junkFiles
|
||||
4. find-longlines
|
||||
|
||||
17
doc/tools/find-its
Executable file
17
doc/tools/find-its
Executable file
@ -0,0 +1,17 @@
|
||||
#!/bin/sh
|
||||
# -----------------------------------------------------------------------------
|
||||
# Script
|
||||
# find-its
|
||||
#
|
||||
# Description
|
||||
# Search for files with "it's"
|
||||
# This contraction (== "it is") looks too much like "its" (possesive)
|
||||
# and confuses non-native (and some native) English speakers.
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
set -x
|
||||
cd $WM_PROJECT_DIR || exit 1
|
||||
|
||||
git grep -e "it's"
|
||||
|
||||
#------------------------------------------------------------------ end-of-file
|
||||
17
doc/tools/find-trailingspace
Executable file
17
doc/tools/find-trailingspace
Executable file
@ -0,0 +1,17 @@
|
||||
#!/bin/bash
|
||||
# -----------------------------------------------------------------------------
|
||||
# Script
|
||||
# find-trailingspace
|
||||
#
|
||||
# Description
|
||||
# Search for files with trailing whitesapce
|
||||
#
|
||||
# -----------------------------------------------------------------------------
|
||||
set -x
|
||||
cd $WM_PROJECT_DIR || exit 1
|
||||
|
||||
tab=$'\t'
|
||||
|
||||
git grep -c -E "[ $tab]+"'$' -- $@
|
||||
|
||||
#------------------------------------------------------------------ end-of-file
|
||||
Reference in New Issue
Block a user