INN commit: branches/2.5/doc/pod (news.pod)

INN Commit rra at isc.org
Wed Mar 24 06:03:45 UTC 2010


    Date: Tuesday, March 23, 2010 @ 23:03:44
  Author: eagle
Revision: 9039

Rewording and editing of changes for 2.5.2

Modified:
  branches/2.5/doc/pod/news.pod

----------+
 news.pod |  326 ++++++++++++++++++++++++++++++-------------------------------
 1 file changed, 165 insertions(+), 161 deletions(-)

Modified: news.pod
===================================================================
--- news.pod	2010-03-24 06:03:33 UTC (rev 9038)
+++ news.pod	2010-03-24 06:03:44 UTC (rev 9039)
@@ -1,27 +1,30 @@
 =head1 Changes in 2.5.2
 
 The way checkpoints are handled by B<innreport> for B<innd> and B<innfeed>
-has totally changed, so as to provide more accurate daily statistics.
-The first Usenet report after an upgrade to S<INN 2.5.2> will probably
-contain untrustful statistics for incoming and outgoing articles (because
-the beginning of the log files that will be used was generated by a previous
-version of INN).
+has totally changed to provide more accurate daily statistics.  The first
+Usenet report after an upgrade to S<INN 2.5.2> will probably contain
+incorrect statistics for incoming and outgoing articles because the
+beginning of the log files that will be used was generated by a previous
+version of INN.
 
-Note that a new version of F<innreport.conf> is shipped with S<INN 2.5.2>.
-Changes are minor and not mandatory for the upgrade.
+A new version of F<innreport.conf> is shipped with S<INN 2.5.2> but, in
+order to preserve any local changes, will not be automatically installed
+with make update.  The changes are minor and not mandatory for the
+upgrade.
 
 =over 2
 
 =item *
 
-Julien Elie has implemented in B<innd> the new version of the NNTP protocol
-described in S<RFC 3977>, S<RFC 4643> and S<RFC 4644>.  Consequently, B<innd>
-now recognizes the CAPABILITIES command.  Notwithstanding these standards,
-three commands (IHAVE, CHECK and TAKETHIS) will continue, for interoperability
-reasons, to return a reject code (respectively C<435>, C<438> and C<439>) when
-the command contains a syntax error (which normally leads to C<501>).  Besides,
-the mandatory username for authenticated peers will only be enforced by
-S<INN 2.6.0>.
+Julien Elie has implemented in B<innd> the new version of the NNTP
+protocol described in S<RFC 3977>, S<RFC 4643> and S<RFC 4644>, and
+B<innd> now recognizes the CAPABILITIES command.  Despite these standards,
+three commands (IHAVE, CHECK and TAKETHIS) will continue, for
+interoperability reasons, to return a reject code (respectively C<435>,
+C<438>, and C<439>) when the command contains a syntax error instead of
+C<501>.  The mandatory username argument for authenticated peers is not
+enforced in S<INN 2.5.2> but will be be enforced by S<INN 2.6.0> when it
+is released.
 
 Major improvements are:
 
@@ -29,25 +32,25 @@
 
 =item *
 
-B<innd> now has a decent parser for NNTP commands.  It permits to have a far
-better grammar parser (commands like C<< IHAVEZ<><mid> >>, without a space between
-the command and its argument, are no longer valid) and to allow leading and
-trailing whitespaces in commands.  Besides, B<innd> checks the length of the
-NNTP command sent by the client:  if the command contains more than 512 bytes
-(or 497 bytes for an argument), an error is returned and the command is
-discarded.  Note that after ten unrecognized commands, B<innd> closes the
+B<innd> now has a decent parser for NNTP commands.  The parser is more
+correct (commands like C<< IHAVEZ<><mid> >>, without a space between the
+command and its argument, are no longer valid) and allows leading and
+trailing whitespaces in commands.  B<innd> also now checks the length of
+the NNTP command sent by the client.  If the command contains more than
+512 bytes (or 497 bytes for an argument), an error is returned and the
+command is discarded.  After ten unrecognized commands, B<innd> closes the
 connection with the appropriate code (C<400> instead of C<500>).
 
 =item *
 
 The output of the HELP command specifies the arguments expected by NNTP
-commands, the same way as B<nnrpd> does.
+commands, similar to B<nnrpd>'s HELP command.
 
 =item *
 
-LIST ACTIVE, LIST ACTIVE.TIMES and LIST NEWSGROUPS recognize an optional
-argument:  a wildmat can now be specified to restrict the results of these
-commands to specific newsgroups.
+LIST ACTIVE, LIST ACTIVE.TIMES and LIST NEWSGROUPS now allow an optional
+wildmat argument to restrict the results of those commands to specific
+newsgroups.
 
 =item *
 
@@ -58,25 +61,24 @@
 
 =item *
 
-Jeffrey S<M. Vinocur> has implemented in both B<innd> and B<nnrpd>
-support for whitespaces in usernames/passwords provided
-with AUTHINFO USER/PASS.  They were previously considered
-as invalid arguments, or wrongly parsed.  B<innd> and B<nnrpd> now treat
-everything after the first whitespace character following AUTHINFO
-USER/PASS, up to, but not including, the final CRLF, as the
-username/password, in conformity with S<RFC 4643>.
+Jeffrey S<M. Vinocur> has implemented support in both B<innd> and B<nnrpd>
+for whitespace in usernames/passwords provided with AUTHINFO USER/PASS.
+They were previously treated as invalid arguments or incorrectly parsed.
+B<innd> and B<nnrpd> now treat everything after the first whitespace
+character following AUTHINFO USER/PASS, up to, but not including, the
+final CRLF, as the username/password, in conformity with S<RFC 4643>.
 
 =item *
 
-The syntax of message-IDs is now based on S<RFC 5536> (USEFOR)
-instead of S<RFC 1036>.  The major change is that quoted-pairs
-have been removed from the syntax.
+The syntax of message-IDs is now based on S<RFC 5536> (USEFOR) instead of
+S<RFC 1036>.  The major change is that quoted-pairs have been removed from
+the syntax.
 
 =item *
 
-The Perl and Python filters for B<innd> now check the message-ID of articles
-arriving through TAKETHIS.  Only CHECK and IHAVE commands previously
-used them.
+The Perl and Python filters for B<innd> now check the message-ID of
+articles arriving through TAKETHIS.  Only CHECK and IHAVE commands
+previously used them.
 
 =item *
 
@@ -91,199 +93,201 @@
 defined in S<RFC 5064> and S<RFC 5536> can be used in B<innd> filters.
 B<nnrpd> now checks at injection time that an article does not contain an
 Injection-Info: header, that an Injection-Date: header (if provided) is
-valid, and that the Path: header does not contain C<.POSTED>.  Note that the
-generation of these two injection fields and the update of the Path: field
-for locally posted articles will only be for the next major release of INN.
+valid, and that the Path: header does not contain C<.POSTED>.  Note that
+INN does not yet generate these two injection fields or include the new
+Path: header field C<.POSTED> keyword.  These new features will be in the
+next major release of INN.
 
 =item *
 
-LIST SUBSCRIPTIONS recognizes an optional argument:  a wildmat
-can now be specified to restrict the results of this command
-to specific newsgroups.
+LIST SUBSCRIPTIONS now accepts an optional wildmat argument to restrict
+the results of this command to specific newsgroups.
 
 =item *
 
-A new LIST variant named COUNTS is supported by B<nnrpd>:  LIST COUNTS
-is a combination of LIST ACTIVE and GROUP.  It returns the same
-result as LIST ACTIVE except that the number of articles in a
-newsgroup is inserted before its status.
+B<nnrpd> now supports a new LIST variant named COUNTS.  LIST COUNTS is a
+combination of LIST ACTIVE and GROUP.  It returns the same result as LIST
+ACTIVE except that the number of articles in a newsgroup is inserted
+before its status.
 
 =item *
 
-A new check has been added to F<newsfeeds> entries:  C<Aj>, when present,
-adds the capability to feed articles accepted and filed in C<junk> (due to
-I<wanttrash>) to peers based on their F<newsfeeds> feed patterns applied to
-the Newsgroups: header as though the article were accepted and all those
-groups were locally carried.  This is useful if you want to run INN with
-a minimal F<active> file and propagate all posts.  Thanks to Andrew Gierth
+A new flag has been added to F<newsfeeds> entries: C<Aj>, when present,
+says to feed articles accepted and filed in C<junk> (due to I<wanttrash>)
+to peers based on their F<newsfeeds> feed patterns applied to the
+Newsgroups: header as though the article were accepted and all those
+groups were locally carried.  This is useful if you want to run INN with a
+minimal F<active> file and propagate all posts.  Thanks to Andrew Gierth
 for the patch.
 
 =item *
 
-A new parameter has been added to F<inn.conf>:  I<logtrash> defines whether
-a line for articles posted to groups not locally carried by the news server
-should be added in the F<news> log file to report unwanted newsgroups.
-The default is true but it can be useful to set it to false (especially
-when I<wanttrash> is also used).
+A new parameter has been added to F<inn.conf>: I<logtrash> defines whether
+a line for articles posted to groups not locally carried by the news
+server should be added in the F<news> log file to report unwanted
+newsgroups.  The default is true but it can be useful to set it to false
+(especially when I<wanttrash> is also used).
 
 =item *
 
-The B<procbatchdir> keyword has been added to B<news.daily> so as to specify
-the backlog directories of B<innfeed> when several instances of B<innfeed>
-are running or when its configuration file is not the default one.
+The B<procbatchdir> keyword has been added to B<news.daily> to specify the
+backlog directory of B<innfeed>.  This is useful when several instances of
+B<innfeed> are running or when its configuration file is not the default
+one.
 
 =item *
 
-A new feature has been added to B<sm>.  When the B<-c> flag is used,
-it shows a clear, decoded form of the storage API token.  This
-was previously done by the contrib B<showtoken> script developed
-by Olaf Titz and Marco d'Itri.
+B<sm> now supports a new flag, B<-c>, which shows a decoded form of the
+storage API token.  This was previously done by the contrib B<showtoken>
+script developed by Olaf Titz and Marco d'Itri.
 
 =item *
 
 The B<O> flag in F<newsfeeds> now relies on the contents of the
-Injection-Info: header (or X-Trace: header if there is no Injection-Info:
-header) to determine the origin of an article.
+Injection-Info: header field if it is present to determine the origin of
+an article.  It falls back on X-Trace: if there is no Injection-Info:
+header field.
 
 =item *
 
 A new "unsigned long" type bas been added to the configuration parser.  It
-will properly warn the news administrator when a variable supposed to
-be positive contains a negative integer.  It will prevent INN
-from crashing at several places where it did not expect negative
+will properly warn the news administrator when a variable supposed to be
+positive contains a negative integer.  It will prevent INN from crashing
+due to misconfiguration at several places where it did not expect negative
 values.
 
 =item *
 
 B<innxbatch> and B<innxmit> now recognize the new C<403> code introduced
-by S<RFC 3977> for a problem preventing the action from being taken.
+by S<RFC 3977> for a problem preventing the requested action from being
+taken.
 
 =item *
 
-HDR and OVER commands now return the right C<423> code (instead of C<420>)
-when the current article number is used but the article no longer exists.
+HDR and OVER commands now return the correct C<423> code (instead of
+C<420>) when the current article number is used but the article no longer
+exists.
 
 =item *
 
 B<actsync>, B<inews>, B<innxbatch>, B<innxmit>, B<nntpget> and B<rnews>
-can now authenticate on news servers which only expect a username,
-without password, in conformity with S<RFC 4643>.
+can now authenticate to news servers which only expect a username, without
+password, conforming to S<RFC 4643>.
 
 =item *
 
-The keyword generation code now generates a Keywords: header only
-if the original article does not already have one.  The generated
-Keywords: header no longer begins with a comma.  Moreover, if
-keyword generation is set to true in F<inn.conf> but the
-Keywords: header is not stored in the overview, the news
-administrator is warned and keyword generation deactivated
-because it would be run for nothing.
+The keyword generation code now generates a Keywords: header only if the
+original article does not already have one.  The generated Keywords:
+header no longer begins with a comma.  If keyword generation is set to
+true in F<inn.conf> but the Keywords: header is not stored in the
+overview, the news administrator is warned and keyword generation
+deactivated, since it exists only to populate the overview data.
 
 =item *
 
-Fixed two segfaults in keyword generation.  The first occurred when
-an article already had a Keywords: header the length of which is greater
-than the I<keylimit> parameter.  The second was caused by a possible
-invalid pointer beyond the newly allocated Keywords: header.
+Two segfaults in keyword generation were fixed.  The first occurred when
+an article already had a Keywords: header longer than the I<keylimit>
+parameter.  The second was caused by a possible invalid pointer beyond the
+newly allocated Keywords: header.
 
 =item *
 
-Fixed a bug in the parsing of empty lines:  B<innd> was not properly
-discarding an empty command, and it was closing the connection upon
-receiving only whitespaces in a command.
+Fixed B<innd> handling of empty lines.  B<innd> was not properly
+discarding an empty command and was closing the connection when it
+received only whitespace in a command.
 
 =item *
 
-Fixed a bug in how B<innd> responded to reader commands when readers
-were not allowed.  A superfluous blank line was sent in its response.
+Fixed a bug in how B<innd> responded to reader commands when readers were
+not allowed.  A superfluous blank line was sent in its response.
 
 =item *
 
-Fixed a bug in TAKETHIS:  when authentication was required, a C<480> code
-was directly answered without treating the whole multi-data block following
-the command from the client, which broke the NNTP protocol.
+Fixed a bug in B<innd>'s response to TAKETHIS when authentication is
+required.  Previously, C<480> code was returned immediately without
+accepting the multi-line data block first, which broke synchronization in
+the NNTP protocol.
 
 =item *
 
-Fixed a bug when empty articles were fed to B<innd> via IHAVE or TAKETHIS:
-the article terminator was not recognized.  Therefore, subsequent NNTP
-commands were eaten inside the article.
+Fixed a bug in recognizing the article terminator when empty articles were
+fed to B<innd> via IHAVE or TAKETHIS, leading to treating subsequent NNTP
+commands as part of the article.
 
 =item *
 
-Fixed a bug when B<innd> could not provide information for LIST ACTIVE.TIMES
-and LIST NEWSGROUPS:  it was giving an invalid result, without any
-response code.  The proper C<503> answer code is now returned.
+When B<innd> could not provide information for LIST ACTIVE.TIMES and LIST
+NEWSGROUPS, it was returning an invalid error message without a response
+code.  The proper C<503> answer code is now returned.
 
 =item *
 
 When an unauthenticated user tried to post an article, B<nnrpd> replied
-C<440> (posting not allowed) instead of the right C<480> (authentication
-required) when the user might be able to post after authentication.
+C<440> (posting not allowed) instead of the correct C<480> (authentication
+required) response if the user might be able to post after authentication.
 Thanks to Daniel Weber for the bug report.
 
 =item *
 
-Fixed a bug in both B<innd> and B<nnrpd> answers to LIST commands which
-did not check for a valid dot-stuffed output.
+Fixed a bug in both B<innd> and B<nnrpd> answers to LIST commands where
+the output was not checked for valid dot stuffing.
 
 =item *
 
-Fixed a bug to control-only feeds:  junked non-control articles were being
-fed down control-only feeds.  Besides, poisoned control groups were not
-properly handled.  Thanks to Andrew Gierth for the patch.
+Fixed a bug leading to junked non-control articles being sent to
+control-only feeds, and also fixed handling of poisoned control groups.
+Thanks to Andrew Gierth for the patch.
 
 =item *
 
-Fixed a bug in B<innreport> which was not correctly summing B<innd>
-stats when I<hostname> was set as an IPv6 address instead of a fully
-qualified domain name.  Thanks to Petr Novopashenniy for the bug report.
+Fixed a bug in B<innreport> leading to incorrect summing of B<innd> stats
+when I<hostname> was set to an IPv6 address instead of a fully-qualified
+domain name.  Thanks to Petr Novopashenniy for the bug report.
 
 =item *
 
-Changed how B<innreport> takes into account B<innd> and B<innfeed> checkpoint
-messages.  Previously, the fact that connections can be open for days led
-to produce skewed numbers on how many articles had been received or sent.
-The count is now more accurate and, for each connection of a feed, only
-depends on I<incominglogfrequency> in F<inn.conf> and I<stats-period>
-in F<innfeed.conf>.
+Changed how B<innreport> uses B<innd> and B<innfeed> checkpoint messages.
+Previously, connections held open for multiple days led to skewed and
+incorrect statistics on how many articles had been received or sent.  The
+count is now more accurate and, for each connection of a feed, only
+depends on I<incominglogfrequency> in F<inn.conf> and I<stats-period> in
+F<innfeed.conf>.
 
 =item *
 
-Fixed a bug in B<nnrpd> Perl filter:  a header field whose name begins with
-the name of a standardized header field was not properly taken into account.
+Fixed a bug in B<nnrpd> Perl filter: a header field whose name begins with
+the name of a standardized header field was not properly handled.
 
 =item *
 
-Fixed a bug on how B<innd> was parsing Message-ID: and Supersedes: headers
-which contained trailing whitespaces.  The article ended up
-corrupted because of an unexpected "\r" in the middle of the header.
-Besides, B<nnrpd> now checks the syntax of the Message-ID: header,
-if present.
+Fixed a bug in how B<innd> was parsing Message-ID: and Supersedes: headers
+which contained trailing whitespace.  The article was corrupted by an
+unexpected "\r" in the middle of the header.  B<nnrpd> now checks the
+syntax of the Message-ID: header field, if present.
 
 =item *
 
-Fixed a bug in how leading whitespaces were treated in headers.  The
-HDR, XHDR and XPAT commands were not properly showing leading whitespaces
-in header values.  Besides, "\n" and "\r" were both changed into spaces
-whereas "\r\n" just was to be removed.  As for B<archive>, B<makehistory>
-and B<tdx-util>, they did not keep leading whitespaces in headers when
-generating overview data, and B<archive> did not change "\n"
-(when not preceded by "\r") into a space when generating overview data.
+Fixed various bugs in how leading whitespace was treated in headers.  The
+HDR, XHDR and XPAT commands were not properly showing leading whitespace
+in header values.  Lone "\n" and "\r" characters are now changed into
+spaces and "\r\n" is just removed.  B<archive>, B<makehistory>, and
+B<tdx-util> now keep leading whitespace in headers when generating
+overview data, and B<archive> now changes "\n" (when not preceded by "\r")
+into a space when generating overview data.
 
 =item *
 
-Fixed a bug in the generation of overview data which may corrupt previously
-generated overview data when a malicious pseudo Xref: header field is
+Fixed a bug in the generation of overview data which may corrupt
+previously generated overview data when a pseudo Xref: header field is
 injected in an extra overview field.
 
 =item *
 
 Fixed a bug in the parsing of the I<ovgrouppat> wildmat in F<inn.conf>
 that prevented overview data from being generated when poisoned groups
-were specified but a latter sub-pattern made the group wanted.  A uwildmat
-expression is now correctly handled, and a potential segfault has been fixed.
-Thanks to Dieter Stussy for the bug report.
+were specified but a latter sub-pattern matched the group.  A uwildmat
+expression is now correctly handled, and a potential segfault has been
+fixed.  Thanks to Dieter Stussy for the bug report.
 
 =item *
 
@@ -293,40 +297,41 @@
 
 =item *
 
-Fixed a bug in B<tdx-util> which was not properly parsing empty overview
-fields when called with B<-A> or B<-F>.
+Fixed a bug in B<tdx-util> in parsing empty overview fields when called
+with B<-A> or B<-F>.
 
 =item *
 
-Fixed a bug in B<cvtbatch> which was returning only the size of the
+Fixed a bug in B<cvtbatch>, which was returning only the size of the
 headers of an article when the C<b> parameter was used with the B<-w>
-flag.  It now correctly returns the size of the whole article, which
-is what C<b> is supposed to do.  Besides, B<cvtbatch> has a new C<t>
-parameter which can be used with the B<-w> flag, so as to retrieve
-the arrival time of an article.
+flag.  It now correctly returns the size of the whole article, which is
+what C<b> was documented to do.  B<cvtbatch> also has a new C<t>
+parameter, which can be used with the B<-w> flag to retrieve the arrival
+time of an article.
 
 =item *
 
 Fixed a bug in how B<mailpost> handles cross-posting feature.  It was not
-properly detaching from B<sendmail>.  Thanks to Harald Dunkel for the patch.
+properly detaching from B<sendmail>.  Thanks to Harald Dunkel for the
+patch.
 
 =item *
 
-Fixed a bug in the F<newsfeeds> B<C> flag:  the count of followup groups
+Fixed a bug in the F<newsfeeds> B<C> flag: the count of followup groups
 was one less than the real number.  When the value of the Followup-To:
-header is C<poster>, it is no longer considered to be a followup.
+header field is C<poster>, it is no longer considered to be a followup.
 Thanks to Dieter Stussy for the patch.
 
 =item *
 
 When using tradindexed, the overview data for a cancelled article is now
-properly immediately removed from the overview.  Thanks to Lars Magne
-Ingebrigtsen for the patch.
+immediately removed from the overview.  Thanks to Lars Magne Ingebrigtsen
+for the patch.
 
 =item *
 
-B<batcher> has not supported the retrieval of an article with its
-file name for a long time.  The B<-S> flag is therefore removed.
+B<batcher> has not supported the retrieval of an article with its file
+name for a long time.  The B<-S> flag has therefore been removed.
 
 =item *
 
@@ -335,20 +340,19 @@
 
 =item *
 
-B<news.daily> no longer sends superfluous mails when the B<nomail>
-keyword is given.  Mail is only sent when there is real output.
-Previously, there would always be headings and empty lines useful
-to structure the full report, which are now ommitted.  Also, the
-output of programs executed with B<postexec> is now included in the
-regular mail.  Thanks to Florian Schlichting for the patch.
+B<news.daily> no longer sends superfluous mails when the B<nomail> keyword
+is given.  Mail is only sent when there is real output.  Previously, there
+would always be headings and empty lines left over from the structuring of
+the full report, which are now ommitted.  Also, the output of programs
+executed with B<postexec> is now included in the regular mail.  Thanks to
+Florian Schlichting for the patch.
 
 =item *
 
 B<innconfval> no longer maps NULL string or list values to an empty string
-or list.  These values should really be undefined.  In particular, it
-fixes an issue reported by Kamil Jonca about B<nnrpd> inserting an empty
-Organization: header when the I<organization> parameter in F<inn.conf>
-was unset.
+or list and instead maps them to undefined values.  This fixes an issue
+reported by Kamil Jonca: B<nnrpd> was inserting an empty Organization:
+header when the I<organization> parameter in F<inn.conf> was unset.
 
 =item *
 




More information about the inn-committers mailing list