Commit 8907dee8f17b652f6ea856d4239598da60f15538

Authored by Jim Plank
1 parent 08d7edc0

Added the user's manual.

Examples/cauchy_04.c
... ... @@ -152,7 +152,7 @@ int main(int argc, char **argv)
152 152  
153 153 /* Print out the matrix and the bitmatrix */
154 154 printf("<hr>\n");
155   - printf("Here is the matrix, which was created with <b>cauchy_xy_coding_matrix()</b>.\n");
  155 + printf("Here is the matrix, which was created with <b>cauchy_good_general_coding_matrix()</b>.\n");
156 156  
157 157 printf("<pre>\n");
158 158 jerasure_print_matrix(matrix, m, k, w);
... ...
Examples/reed_sol_test_gf.c
... ... @@ -70,7 +70,7 @@ static void free16(void *ptr) {
70 70  
71 71 usage(char *s)
72 72 {
73   - fprintf(stderr, "usage: reed_sol_test_gf k m w seed [additional GF args]- Tests Reed-Solomon in GF(2^w).\n");
  73 + fprintf(stderr, "usage: reed_sol_test_gf k m w seed (additional GF args) - Tests Reed-Solomon in GF(2^w).\n");
74 74 fprintf(stderr, " \n");
75 75 fprintf(stderr, " w must be 8, 16 or 32. k+m must be <= 2^w.\n");
76 76 fprintf(stderr, " See the README for information on the additional GF args.\n");
... ... @@ -107,7 +107,7 @@ int main(int argc, char **argv)
107 107 gf_t *gf = NULL;
108 108 uint32_t seed;
109 109  
110   - if (argc < 6) usage(NULL);
  110 + if (argc < 6) usage("Not enough command line arguments");
111 111 if (sscanf(argv[1], "%d", &k) == 0 || k <= 0) usage("Bad k");
112 112 if (sscanf(argv[2], "%d", &m) == 0 || m <= 0) usage("Bad m");
113 113 if (sscanf(argv[3], "%d", &w) == 0 || (w != 8 && w != 16 && w != 32)) usage("Bad w");
... ...
README
... ... @@ -5,7 +5,8 @@ instructions.
5 5  
6 6 External Documentation:
7 7  
8   -See technical report CS-08-627 for a description of the main interfaces (Version 1.2)
  8 +See the file Manual.pdf for the programmer's manual and tutorial. This manual
  9 +is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.
9 10  
10 11 See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
11 12  
... ...
README.nd
... ... @@ -5,7 +5,8 @@ instructions.
5 5  
6 6 External Documentation:
7 7  
8   -See technical report CS-08-627 for a description of the main interfaces (Version 1.2)
  8 +See the file Manual.pdf for the programmer's manual and tutorial. This manual
  9 +is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.
9 10  
10 11 See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
11 12  
... ...
README.txt
... ... @@ -5,7 +5,8 @@ instructions.
5 5  
6 6 External Documentation:
7 7  
8   -See technical report CS-08-627 for a description of the main interfaces (Version 1.2)
  8 +See the file Manual.pdf for the programmer's manual and tutorial. This manual
  9 +is also available at http://web.eecs.utk.edu/~plank/plank/papers/UT-EECS-14-721.html.
9 10  
10 11 See https://bitbucket.org/jimplank/gf-complete for GF-Complete.
11 12  
... ...