Skip to contentSkip to conversation

open_wmemstream(3): Describe (as part of fmemopen.3)

PATCH In review Petr Baudis 2 participants 4 messages Dec 4, 2008 – Dec 6, 2008 3 messages not in the archive Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore

Petr Baudis

author
#0 lore raw

PATCH 1/1 open_wmemstream(3): Describe (as part of fmemopen.3)

Signed-off-by Petr Baudis <[email protected]>
man3/fmemopen.3 +13 -4
index 47187b6..add9d5f 100644
@@ -2,9 +2,9 @@
 .\" and Copyright 2005 Michael Kerrisk <[email protected]>
 .\" Distributed under the GPL.
 .\"
-.TH FMEMOPEN 3 2008-10-12 "GNU" "Linux Programmer's Manual"
+.TH FMEMOPEN 3 2008-12-04 "GNU" "Linux Programmer's Manual"
 .SH NAME
-fmemopen, open_memstream \-  open memory as stream
+fmemopen, open_memstream, open_wmemstream \-  open memory as stream
 .SH SYNOPSIS
 .B #define _GNU_SOURCE
 .br

@@ -14,6 +14,10 @@ fmemopen, open_memstream \-  open memory as stream
 .BI "const char *" mode ");"
 .sp
 .BI "FILE *open_memstream(char **" ptr ", size_t *" sizeloc );
+.sp
+.B #include <wchar.h>
+.br
+.BI "FILE *open_wmemstream(wchar_t **" ptr ", size_t *" sizeloc );
 .SH DESCRIPTION
 The
 .BR fmemopen ()

@@ -138,11 +142,16 @@ or
 Moving the file position past the end
 of the data already written fills the intervening space with
 zeros.
+
+The
+.BR open_wmemstream ()
+is similar but operates on wide characters instead of bytes.
 .SH "RETURN VALUE"
 Upon successful completion
-.BR fmemopen ()
-and
+.BR fmemopen (),
 .BR open_memstream ()
+and
+.BR open_wmemstream ()
 return a
 .I FILE
 pointer.
man3/open_wmemstream.3 new file +1 -0
new file mode 100644
index 0000000..afcad2f
@@ -0,0 +1 @@
+.so man3/fmemopen.3

--
To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): [email protected]

#2 lore raw

Hi Petr,

Thanks for another good patch. One thing (since you may be submitting future patches, I hope): the subject line would be better as something like:

[PATCH] fmemopen.3: Add description of open_wmemstream(3)

Other comments below.

man3/fmemopen.3 line 3

Quoted 9 lines · Petr Baudis
Signed-off-by Petr Baudis <[email protected]>
man3/fmemopen.3 +0 -0
index 47187b6..add9d5f 100644
@@ -2,9 +2,9 @@
 .\" and Copyright 2005 Michael Kerrisk <[email protected]>
 .\" Distributed under the GPL.

This time I added an in-source changelog entry listing you!

Quoted 10 lines
man3/fmemopen.3 +2 -2
 .\"
-.TH FMEMOPEN 3 2008-10-12 "GNU" "Linux Programmer's Manual"
+.TH FMEMOPEN 3 2008-12-04 "GNU" "Linux Programmer's Manual"
 .SH NAME
-fmemopen, open_memstream \-  open memory as stream
+fmemopen, open_memstream, open_wmemstream \-  open memory as stream
 .SH SYNOPSIS
 .B #define _GNU_SOURCE
 .br

man3/fmemopen.3 fmemopen, open_memstream \- open memory as stream · line 17

Quoted 4 lines
man3/fmemopen.3 +1 -0
@@ -14,6 +14,10 @@ fmemopen, open_memstream \-  open memory as stream
 .BI "const char *" mode ");"
 .sp
 .BI "FILE *open_memstream(char **" ptr ", size_t *" sizeloc );
+.sp

I imagine you were aware that _GNU_SOURCE is required. Convention here is that since we are listing new header files, then we should again list the required FTMs, even if they are the same as for a previous function. So I added

+.B #define _GNU_SOURCE

here.

Quoted 15 lines
man3/fmemopen.3 +7 -0
+.B #include <wchar.h>
+.br
+.BI "FILE *open_wmemstream(wchar_t **" ptr ", size_t *" sizeloc );
 .SH DESCRIPTION
 The
 .BR fmemopen ()

@@ -138,11 +142,16 @@ or
 Moving the file position past the end
 of the data already written fills the intervening space with
 zeros.
+
+The
+.BR open_wmemstream ()
+is similar but operates on wide characters instead of bytes.
 .SH "RETURN VALUE"

man3/fmemopen.3 or · line 157

Quoted 10 lines
man3/fmemopen.3 +3 -2
 Upon successful completion
-.BR fmemopen ()
-and
+.BR fmemopen (),
 .BR open_memstream ()
+and
+.BR open_wmemstream ()
 return a
 .I FILE
 pointer.

One thing that also is good to include is version information. Unfortunately the page was lacking a VERSIONS section, when it really should have had one. I added the following:

man3/fmemopen.3 +7 -0
index 2b87b69..0d540b5 100644
@@ -160,6 +160,13 @@ pointer.
 Otherwise, NULL is returned and the global variable
 .I errno
 is set to indicate the error.
+.SH VERSIONS
+.BR fmemopen ()
+is available since glibc 2.2.
+.BR open_memstream ()
+is available since glibc 2.0.
+.BR open_wmemstream ()
+is available since glibc 2.4.
 .SH "CONFORMING TO"
 These functions are GNU extensions.
 .\" Jan 06: But they appear to be going up for standardization by

Look right to you?

man3/open_wmemstream.3 line 1

Quoted 7 lines
man3/open_wmemstream.3 new file +1 -0
new file mode 100644
index 0000000..afcad2f
@@ -0,0 +1 @@
+.so man3/fmemopen.3

It's rare that I get a patch that remembers to do pieces like this. Thanks!

These changes are applied for 3.15. Thanks!

Cheers,

Michael

Signature · 9 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
git://git.kernel.org/pub/scm/docs/man-pages/man-pages.git
man-pages online: http://www.kernel.org/doc/man-pages/online_pages.html
Found a bug? http://www.kernel.org/doc/man-pages/reporting_bugs.html
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): cfd18e0f0812050953l4b0a6ca0mf2994623474b149f-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org

author
#4 lore raw

Hi,

thanks for all the comments.

Quoted 23 lines · Michael Kerrisk

One thing that also is good to include is version information. Unfortunately the page was lacking a VERSIONS section, when it really should have had one. I added the following:

man3/fmemopen.3 +7 -0
index 2b87b69..0d540b5 100644
@@ -160,6 +160,13 @@ pointer.
 Otherwise, NULL is returned and the global variable
 .I errno
 is set to indicate the error.
+.SH VERSIONS
+.BR fmemopen ()
+is available since glibc 2.2.
+.BR open_memstream ()
+is available since glibc 2.0.
+.BR open_wmemstream ()
+is available since glibc 2.4.
 .SH "CONFORMING TO"
 These functions are GNU extensions.
 .\" Jan 06: But they appear to be going up for standardization by
Quoted 1 line

Look right to you?

open_wmemstream() yes. fmemopen() is much much older (bear in mind that there was old GNU stdio library before GNU libio, and it contained fmemopen() too - I have no idea which libc version "Thu Aug 8 00:39:56 1991 +0000" is in, though) and same for open_memstream (Sun Jul 28 00:22:19 1991 +0000).

Signature · 7 lines
				Petr "Pasky" Baudis
People who take cold baths never have rheumatism, but they have
cold baths.
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

A message that is not in the archive (sent off-list or not yet received): [email protected]

#6 lore raw
Quoted 28 lines · Petr Baudis

Hi,

thanks for all the comments.

Quoted 23 lines · Michael Kerrisk

One thing that also is good to include is version information. Unfortunately the page was lacking a VERSIONS section, when it really should have had one. I added the following:

man3/fmemopen.3 +7 -0
index 2b87b69..0d540b5 100644
@@ -160,6 +160,13 @@ pointer.
 Otherwise, NULL is returned and the global variable
 .I errno
 is set to indicate the error.
+.SH VERSIONS
+.BR fmemopen ()
+is available since glibc 2.2.
+.BR open_memstream ()
+is available since glibc 2.0.
+.BR open_wmemstream ()
+is available since glibc 2.4.
 .SH "CONFORMING TO"
 These functions are GNU extensions.
 .\" Jan 06: But they appear to be going up for standardization by
Quoted 7 lines
Quoted 1 line

Look right to you?

open_wmemstream() yes. fmemopen() is much much older (bear in mind that there was old GNU stdio library before GNU libio, and it contained fmemopen() too - I have no idea which libc version "Thu Aug 8 00:39:56 1991 +0000" is in, though) and same for open_memstream (Sun Jul 28 00:22:19 1991 +0000).

Thanks for catching that. I made the text

.BR fmemopen ()
and
.BR open_memstream ()
were already available in glibc 1.0.x.
.BR open_wmemstream ()
is available since glibc 2.4.

Cheers,

Michael

Signature · 9 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
git://git.kernel.org/pub/scm/docs/man-pages/man-pages.git
man-pages online: http://www.kernel.org/doc/man-pages/online_pages.html
Found a bug? http://www.kernel.org/doc/man-pages/reporting_bugs.html
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html