i#1734 drfuzz: update documentation for using newly added fuzz options

Commit log for first patchset:
---------------
i#1734 drfuzz: update documentation for using newly added fuzz options

- update fuzzer.dox for using options -fuzz_module, -fuzz_function,
  -fuzz_offset, -fuzz_data_idx, and -fuzz_size_idx.
---------------

[bruening, 2015-12-03 16:20:18]

The existing docs that explain everything should be integrated into the split
options, rather than separated and way down below in the docs.

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox
File drmemory/docs/fuzzer.dox (right):

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:44: options \p -fuzz_module, \p -fuzz_function, and \p
-fuzz_offset.
Explain these further: they are mutually exclusive; what is a "module" (often
confuses people); give example.

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:45: Users can use \p -fuzz_num_args, \p -fuzz_data_idx
and
style: we use , before final element in a list

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:46: \p -fuzz_size_idx to tell Dr. Memroy the number of
arguments passed to
spelling!!!!!!!!!!!!!

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:48: its size in function arguments.
I find this sentence hard to read -- too many "and...".  Seems best to split,
and explain what an "idx" is: it will not be clear to many people.

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:49: For example, to fuzz the following C functon in the
application
spelling again

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:58: or you can use the option \p -fuzz for simplicity
since all the option
I would say new sentence

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:59: value matches the default option value.
grammar

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:64: symbol name, or its offset from the start of the
module. In addition, to
This should be up by the -fuzz_function description above

https://codereview.appspot.com/278310043/diff/1/drmemory/docs/fuzzer.dox#newc...
drmemory/docs/fuzzer.dox:67: argument specifies the size of the fuzzed argument.
For example, to fuzz
This should also be up by -fuzz_num_args, etc.

[zhaoqin, 2015-12-03 23:32:26]

Commit log for latest patchset:
---------------
i#1734 drfuzz: update documentation for using newly added fuzz options

- update fuzzer.dox for using options -fuzz_module, -fuzz_function,
  -fuzz_offset, -fuzz_num_args, -fuzz_data_idx, -fuzz_size_idx,
  and -fuzz_num_iters

Review-URL: https://codereview.appspot.com/278310043
---------------

[bruening, 2015-12-04 18:17:54]

Probably one more iteration would be best

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox
File drmemory/docs/fuzzer.dox (right):

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:30: that has \p -fuzz prefix.
bug: grammar

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:46: or its offset from the start of the module with
following options:
grammar: missing "the"

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:48: (a) \p -fuzz_module: the module name (e.g.,
chrome.exe or libc.so),
I don't think this is going to display properly in html: I suspect it will be
all run together and will not look like a list at all.  It would be best to use
Doxygen list syntax to get a proper html list.  Please test it by looking at the
produced html docs.

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:48: (a) \p -fuzz_module: the module name (e.g.,
chrome.exe or libc.so),
Generally ; is a better choice for separating independent list line items than ,

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:52: (c) \p -fuzz_offset: the offset from the module
base.
Hmm, but these 3 are not equal mutually-exclusive peers:  module and function go
together and would never be specified with offset, right?  It seems like the
list should reflect that.

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:57: (a) \p -fuzz_num_args: how many arguments it has
via
Incomplete sentence??

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:59: (b) \p -fuzz_data_idx: which argument should be
fuzzed,
Please concretely explain how "which argument" is specified: it is the ordinal
number of the argument (which we call the "index", to explain the "idx" name)
passed to the function.

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:63: (d) \p -fuzz_num_iters: how many iterations the
function to be repeated.
is

https://codereview.appspot.com/278310043/diff/20001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:65: For example, to fuzz the following C function in
the "a.out" executable
:

[zhaoqin, 2015-12-07 19:58:25]

Commit log for latest patchset:
---------------
i#1734 drfuzz: update documentation for using newly added fuzz options

- update fuzzer.dox for using options -fuzz_module, -fuzz_function,
  -fuzz_offset, -fuzz_num_args, -fuzz_data_idx, -fuzz_size_idx,
  and -fuzz_num_iters

Review-URL: https://codereview.appspot.com/278310043
---------------

[zhaoqin, 2015-12-07 20:00:55]

Commit log for latest patchset:
---------------
i#1734 drfuzz: update documentation for using newly added fuzz options

- update fuzzer.dox for using options -fuzz_module, -fuzz_function,
  -fuzz_offset, -fuzz_num_args, -fuzz_data_idx, -fuzz_size_idx,
  and -fuzz_num_iters

Review-URL: https://codereview.appspot.com/278310043
---------------

[bruening, 2015-12-07 20:28:55]

LGTM w/ comments

https://codereview.appspot.com/278310043/diff/60001/drmemory/docs/fuzzer.dox
File drmemory/docs/fuzzer.dox (right):

https://codereview.appspot.com/278310043/diff/60001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:30: that have \p -fuzz prefix.
grammar: missing article.

suggest: "that all share a \p -fuzz_ prefix"

https://codereview.appspot.com/278310043/diff/60001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:47: - \p -fuzz_module: the module name (e.g.,
chrome.exe or libc.so);
I would explain that this is the file name of the library or executable

https://codereview.appspot.com/278310043/diff/60001/drmemory/docs/fuzzer.dox#...
drmemory/docs/fuzzer.dox:48: - \p -fuzz_function/-fuzz_offset: the target
function name or
Is it clear what this means?  Probably doxygen puts the "/" in fixed-width too
which makes this seem like a single weirdly-named long option.  Seems best to
separate these.  Maybe you need two separate lists, a nested list, or sthg.

[zhaoqin, 2015-12-07 21:38:07]

Committed as
https://github.com/DynamoRIO/drmemory/commit/cac48767835ab9b31f568baebb537ec2...

Final commit log: 
---------------
i#1734 drfuzz: update documentation for using newly added fuzz options

- update fuzzer.dox for using options -fuzz_module, -fuzz_function,
  -fuzz_offset, -fuzz_num_args, -fuzz_data_idx, -fuzz_size_idx,
  and -fuzz_num_iters

Review-URL: https://codereview.appspot.com/278310043
---------------