Permalink
Browse files

Add comment on modification of read_model() argument.

  • Loading branch information...
1 parent 3e4f306 commit 7b16a2331e1e896208d3db2100af02c94b65aabd @madler committed Oct 23, 2016
Showing with 2 additions and 1 deletion.
  1. +2 −1 model.h
View
@@ -83,7 +83,8 @@ typedef struct {
/* Read and verify a CRC model description from the string str, returning the
result in *model. Return 0 on success, 1 on invalid input, or 2 if out of
- memory. model->name is allocated and should be freed when done.
+ memory. model->name is allocated and should be freed when done. str is
+ modified in the process, and so it cannot be a literal string.
The parameters are "width", "poly", "init", "refin", "refout", "xorout",
"check", and "name". The names may be abbrievated to "w", "p", "i", "r",

0 comments on commit 7b16a23

Please sign in to comment.