Merge branch 'refs/heads/t/doc'
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 6 May 2018 08:54:47 +0000 (10:54 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 6 May 2018 08:55:52 +0000 (10:55 +0200)
Some minor documentation improvements. Cooking for four months.

* refs/heads/t/doc:
  Fix bad grammar "allows <infinitive>".
  doc: Move filter examples to man page.
  doc: Move sender examples to manual page.

1  2 
NEWS.md
mp.c
vss.c

diff --combined NEWS.md
+++ b/NEWS.md
@@@ -1,13 -1,6 +1,15 @@@
  NEWS
  ====
  
 +-------------------------------------------
 +0.6.2 (to be accounced) "elastic diversity"
 +-------------------------------------------
 +
 +- para_gui no longer waits up to one second to update the screen when
 +the geometry of the terminal changes.
 +
++- Minor documentation improvements.
++
  ----------------------------------------
  0.6.1 (2017-09-23) "segmented iteration"
  ----------------------------------------
diff --combined mp.c
--- 1/mp.c
--- 2/mp.c
+++ b/mp.c
@@@ -6,10 -6,10 +6,10 @@@
   * This file contains the public and the private API of the flex/bison based
   * mood parser.
   *
-  * The public API (at the bottom of the file) allows to parse the same mood
+  * The public API (at the bottom of the file) allows parsing the same mood
   * definition many times in an efficient manner.
   *
 - * The first function to all is \ref mp_init(), which analyzes the given mood
 + * The first function to call is \ref mp_init(), which analyzes the given mood
   * definition syntactically. It returns the abstract syntax tree of the mood
   * definition and pre-compiles all regular expression patterns to make later
   * pattern matching efficient.
@@@ -61,8 -61,8 +61,8 @@@ struct mp_context 
   *
   * This function turns a generalized C99 string literal like "xyz\n" into a C
   * string (containing the three characters 'x', 'y' and 'z', followed by a
-  * newline character and the terminating zero byte). The function allows to
-  * specify different quote characters so that, for example, regular expression
+  * newline character and the terminating zero byte). The function receives
+  * quote characters as an argument so that, for example, regular expression
   * patterns enclosed in '/' can be parsed as well. To parse a proper string
   * literal, one has to pass two double quotes as the second argument.
   *
diff --combined vss.c
--- 1/vss.c
--- 2/vss.c
+++ b/vss.c
@@@ -25,8 -25,8 +25,8 @@@
  #include "string.h"
  #include "afh.h"
  #include "afs.h"
 -#include "server.h"
  #include "net.h"
 +#include "server.h"
  #include "list.h"
  #include "send.h"
  #include "sched.h"
@@@ -298,7 -298,7 +298,7 @@@ static int initialize_fec_client(struc
        if (fcp->init_fec) {
                /*
                 * Set the maximum slice size to the Maximum Packet Size if the
-                * transport protocol allows to determine this value. The user
+                * transport protocol allows determination of this value. The user
                 * can specify a slice size up to this value.
                 */
                ret = fcp->init_fec(fc->sc);
@@@ -997,7 -997,7 +997,7 @@@ static void recv_afs_result(struct vss_
                goto err;
        }
        ret = para_mmap(statbuf.st_size, PROT_READ, MAP_PRIVATE | MAP_POPULATE,
 -              passed_fd, 0, &vsst->map);
 +              passed_fd, &vsst->map);
        if (ret < 0)
                goto err;
        vsst->mapsize = statbuf.st_size;