part of feature/doc changes

libtom · Feb 28, 2017 · 6c8d00d · 6c8d00d
1 parent b44aa8f
commit 6c8d00d
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 libtomcrypt
 ==========
 
-See doc/crypt.pdf for a detailed documentation
+See `doc/crypt.pdf` for a detailed documentation
 
 Project Status
 --------------
@@ -13,6 +13,10 @@ Submitting patches
 
 Please branch off from develop if you want to submit a patch.
 
+Patch integration will be faster if tests and documentation are included.
+
+Please update the makefiles in a separate commit. To update them simply run the `updatemakes.sh` script.
+
 Branches
 --------
 

diff --git a/makefile b/makefile
@@ -357,10 +357,10 @@ docs: crypt.tex
 	rm -f doc/crypt.pdf $(LEFTOVERS)
 	cp crypt.tex crypt.bak
 	touch --reference=crypt.tex crypt.bak
-	(echo "\\def\\fixedpdfdate{"; date +'D:%Y%m%d%H%M%S%:z' -d @$$(stat --format=%Y crypt.tex) | sed "s/:\([0-9][0-9]\)$$/'\1'}/g") > crypt-deterministic.tex
-	echo "\\pdfinfo{" >> crypt-deterministic.tex
-	echo "/CreationDate (\fixedpdfdate)" >> crypt-deterministic.tex
-	echo "/ModDate (\fixedpdfdate) }" >> crypt-deterministic.tex
+	(printf "%s" "\def\fixedpdfdate{"; date +'D:%Y%m%d%H%M%S%:z' -d @$$(stat --format=%Y crypt.tex) | sed "s/:\([0-9][0-9]\)$$/'\1'}/g") > crypt-deterministic.tex
+	printf "%s\n" "\pdfinfo{" >> crypt-deterministic.tex
+	printf "%s\n" "  /CreationDate (\fixedpdfdate)" >> crypt-deterministic.tex
+	printf "%s\n}\n" "  /ModDate (\fixedpdfdate)" >> crypt-deterministic.tex
 	cat crypt.tex >> crypt-deterministic.tex
 	mv crypt-deterministic.tex crypt.tex
 	touch --reference=crypt.bak crypt.tex
@@ -369,7 +369,7 @@ docs: crypt.tex
 	latex crypt > /dev/null
 	makeindex crypt.idx > /dev/null
 	perl fixupind.pl
-	pdflatex crypt
+	pdflatex crypt > /dev/null
 	sed -b -i 's,^/ID \[.*\]$$,/ID [<0> <0>],g' crypt.pdf
 	mv -ivf crypt.pdf doc/crypt.pdf
 	mv crypt.bak crypt.tex

diff --git a/run.sh b/run.sh
@@ -13,7 +13,7 @@ else
 fi
 
 rm -f testok.txt
-bash build.sh " $1" "$2 -Os" " $3 IGNORE_SPEED=1 LTC_SMALL=1" "$4" "$5"
+bash build.sh " $1" "$2 -Os" "$3 IGNORE_SPEED=1 LTC_SMALL=1" "$4" "$5"
 if [ -a testok.txt ] && [ -f testok.txt ]; then
    echo
 else
@@ -23,7 +23,7 @@ else
 fi
 
 rm -f testok.txt
-bash build.sh " $1" " $2" " $3 " "$4" "$5"
+bash build.sh " $1" "$2" "$3" "$4" "$5"
 if [ -a testok.txt ] && [ -f testok.txt ]; then
    echo
 else

diff --git a/src/pk/pkcs1/pkcs_1_mgf1.c b/src/pk/pkcs1/pkcs_1_mgf1.c
@@ -19,9 +19,9 @@
 
 /**
    Perform PKCS #1 MGF1 (internal)
+   @param hash_idx    The index of the hash desired
    @param seed        The seed for MGF1
    @param seedlen     The length of the seed
-   @param hash_idx    The index of the hash desired
    @param mask        [out] The destination
    @param masklen     The length of the mask desired
    @return CRYPT_OK if successful