Added the user's manual.

master
Jim Plank 2014-01-29 15:56:05 -05:00
parent 08d7edc092
commit 8907dee8f1
5 changed files with 9 additions and 6 deletions

View File

@ -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);

View File

@ -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");

3
README
View File

@ -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.

View File

@ -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.

View File

@ -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.