Skip to content

Commit

Permalink
Fix poptFreeContext() return type in the man page
Browse files Browse the repository at this point in the history
poptFreeContext() has returned explicit NULL since forever (at least
popt 1.13, didn't bother checking earlier)
  • Loading branch information
pmatilai authored and ffesti committed Sep 24, 2024
1 parent 8a4f26d commit 7a5e1d5
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions popt.3
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ popt \- Parse command line options
.BI " const struct poptOption * " options ,
.BI " unsigned int " flags );
.sp
.BI "void poptFreeContext(poptContext " con );
.BI "poptContext poptFreeContext(poptContext " con );
.sp
.BI "void poptResetContext(poptContext " con );
.sp
Expand Down Expand Up @@ -350,14 +350,14 @@ When argument processing is complete, the process should free the
.BR poptContext " as it contains dynamically allocated components. The "
.BR poptFreeContext() " function takes a "
.BR poptContext " as its sole argument and frees the resources the "
context is using.
context is using. It always returns NULL for convenience.
.sp
.RB "Here are the prototypes of both " poptResetContext() " and "
.BR poptFreeContext() :
.sp
.nf
.B #include <popt.h>
.BI "void poptFreeContext(poptContext " con ");"
.BI "poptContext poptFreeContext(poptContext " con ");"
.BI "void poptResetContext(poptContext " con ");"
.fi
.sp
Expand Down

0 comments on commit 7a5e1d5

Please sign in to comment.