summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Plank <plank@cs.utk.edu>2014-01-29 15:56:05 -0500
committerJim Plank <plank@cs.utk.edu>2014-01-29 15:56:05 -0500
commit8907dee8f17b652f6ea856d4239598da60f15538 (patch)
tree964a81ae0cc451602df85ff9c1aaafb867e4edeb
parent08d7edc092594fe28ae70699762a8915f6d79685 (diff)
downloadjerasure-8907dee8f17b652f6ea856d4239598da60f15538.tar.gz
Added the user's manual.
-rw-r--r--Examples/cauchy_04.c2
-rw-r--r--Examples/reed_sol_test_gf.c4
-rw-r--r--README3
-rw-r--r--README.nd3
-rw-r--r--README.txt3
5 files changed, 9 insertions, 6 deletions
diff --git a/Examples/cauchy_04.c b/Examples/cauchy_04.c
index 1db9df3..6525de3 100644
--- a/Examples/cauchy_04.c
+++ b/Examples/cauchy_04.c
@@ -152,7 +152,7 @@ int main(int argc, char **argv)
/* Print out the matrix and the bitmatrix */
printf("<hr>\n");
- printf("Here is the matrix, which was created with <b>cauchy_xy_coding_matrix()</b>.\n");
+ printf("Here is the matrix, which was created with <b>cauchy_good_general_coding_matrix()</b>.\n");
printf("<pre>\n");
jerasure_print_matrix(matrix, m, k, w);
diff --git a/Examples/reed_sol_test_gf.c b/Examples/reed_sol_test_gf.c
index 611f813..95ea54e 100644
--- a/Examples/reed_sol_test_gf.c
+++ b/Examples/reed_sol_test_gf.c
@@ -70,7 +70,7 @@ static void free16(void *ptr) {
usage(char *s)
{
- fprintf(stderr, "usage: reed_sol_test_gf k m w seed [additional GF args]- Tests Reed-Solomon in GF(2^w).\n");
+ fprintf(stderr, "usage: reed_sol_test_gf k m w seed (additional GF args) - Tests Reed-Solomon in GF(2^w).\n");
fprintf(stderr, " \n");
fprintf(stderr, " w must be 8, 16 or 32. k+m must be <= 2^w.\n");
fprintf(stderr, " See the README for information on the additional GF args.\n");
@@ -107,7 +107,7 @@ int main(int argc, char **argv)
gf_t *gf = NULL;
uint32_t seed;
- if (argc < 6) usage(NULL);
+ if (argc < 6) usage("Not enough command line arguments");
if (sscanf(argv[1], "%d", &k) == 0 || k <= 0) usage("Bad k");
if (sscanf(argv[2], "%d", &m) == 0 || m <= 0) usage("Bad m");
if (sscanf(argv[3], "%d", &w) == 0 || (w != 8 && w != 16 && w != 32)) usage("Bad w");
diff --git a/README b/README
index d7fed34..2bd77d4 100644
--- a/README
+++ b/README
@@ -5,7 +5,8 @@ instructions.
External Documentation:
-See technical report CS-08-627 for a description of the main interfaces (Version 1.2)
+See the file Manual.pdf for the programmer's manual and tutorial. This manual
+is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.
See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
diff --git a/README.nd b/README.nd
index d7fed34..2bd77d4 100644
--- a/README.nd
+++ b/README.nd
@@ -5,7 +5,8 @@ instructions.
External Documentation:
-See technical report CS-08-627 for a description of the main interfaces (Version 1.2)
+See the file Manual.pdf for the programmer's manual and tutorial. This manual
+is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.
See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
diff --git a/README.txt b/README.txt
index d7fed34..2bd77d4 100644
--- a/README.txt
+++ b/README.txt
@@ -5,7 +5,8 @@ instructions.
External Documentation:
-See technical report CS-08-627 for a description of the main interfaces (Version 1.2)
+See the file Manual.pdf for the programmer's manual and tutorial. This manual
+is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.
See https://bitbucket.org/jimplank/gf-complete for GF-Complete.