[PATCH v6 0/5] Rewrite documentation for string-copying functions

[Alejandro Colomar <alx.manpages@gmail.com>]

Hi,

Yet another revision of this patch set.

v6:

-  Fixed a link page (stpcpy(3)).

-  Use malloc(3) in the examples, to show that buffers need to be
   properly allocated before these calls.

-  Return to the example program of strncat(3) that showed a more
   reallistic use (based on groff(1)'s source code, plus some
   imagination).

-  Use the term 'end' for one after the last element of an array, to be
   consistent with C++ (as Andrew pointed out).  It is also less to
   type, and using end for the end of the string and past_end for the
   buffer was a bit confusing, since it wasn't true that
   'end == past_end - 1'.  Now, I don't have a term for the end of a
   string, so I used the description instead of a term.  The name of
   such pointers is called 'p', following tradition (and the name of
   mempcpy(3) and stpcpy(3) and others).


This is likely to be the last revision before pushing.  I don't expect
important changes to occur, and I think we can improve the page once
it's been published.  This is already a big improvement over what we've
had for many years, and worth of being released to the public.


Cheers,

Alex


P.S.: I'm writing a library that implements the functions suggested here
that are not part of libc.  The code is already done, and I'm now
working on the build system.  After that, manual pages and Debian
packaging (I'll need help for the latter), and it'll be done.


Alejandro Colomar (5):
  string_copy.7: Add page to document all string-copying functions
  stpecpy.3, stpecpyx.3, ustpcpy.3, ustr2stp.3, zustr2stp.3,
    zustr2ustp.3: Add new links to string_copy(7)
  stpcpy.3, strcpy.3, strcat.3: Document in a single page
  stpncpy.3, strncpy.3: Document in a single page
  strncat.3: Rewrite to be consistent with string_copy.7.

 man3/stpcpy.3      | 116 +-----
 man3/stpecpy.3     |   1 +
 man3/stpecpyx.3    |   1 +
 man3/stpncpy.3     | 166 +++++----
 man3/strcat.3      | 162 +--------
 man3/strcpy.3      | 234 ++++++++-----
 man3/strncat.3     | 157 +++------
 man3/strncpy.3     | 130 +------
 man3/ustpcpy.3     |   1 +
 man3/ustr2stp.3    |   1 +
 man3/zustr2stp.3   |   1 +
 man3/zustr2ustp.3  |   1 +
 man7/string_copy.7 | 855 +++++++++++++++++++++++++++++++++++++++++++++
 13 files changed, 1172 insertions(+), 654 deletions(-)
 create mode 100644 man3/stpecpy.3
 create mode 100644 man3/stpecpyx.3
 create mode 100644 man3/ustpcpy.3
 create mode 100644 man3/ustr2stp.3
 create mode 100644 man3/zustr2stp.3
 create mode 100644 man3/zustr2ustp.3
 create mode 100644 man7/string_copy.7

-- 
2.39.0