Nomenclature of udev documentation

Nomenclature of udev documentation

[Christopher Culver]

Udev comes with a "ChangeLog" file. However, the contents of this file
are a friendly summary of changes instead of the very specific and
technical remarks usually contained in file of that name. According to
the GNU tradition of documentation, now upheld by most Free Software
project, this file would more appropriately be called NEWS. I request
that the maintainers change the name of this file, since consistency
is good.

Christopher Culver


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id\x14396&op=click
_______________________________________________
Linux-hotplug-devel mailing list  http://linux-hotplug.sourceforge.net
Linux-hotplug-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: Nomenclature of udev documentation

[Greg KH]

On Thu, Feb 10, 2005 at 05:36:01PM -0600, Christopher Culver wrote:
> Udev comes with a "ChangeLog" file. However, the contents of this file
> are a friendly summary of changes instead of the very specific and
> technical remarks usually contained in file of that name. According to
> the GNU tradition of documentation, now upheld by most Free Software
> project, this file would more appropriately be called NEWS. I request
> that the maintainers change the name of this file, since consistency
> is good.

udev has _nothing_ to do with GNU traditions, nor the Free Software
project, with the exception being that it uses the GPL v2 for its
license.

The file, ChangeLog, is automatically generated by the same script that
generates the Linux Kernel ChangeLog comments that get posted to the
linux-kernel mailing list with each kernel release.  That is why I
chose that format.

Also, the format you are specifying, lends itself to being created by
cvs.  udev uses BitKeeper for its version control system, which is
vastly different.

I, however, am very happy that you enjoy the udev program so much that
the only thing wrong you can find with it is the format that the
ChangeLog file is in :)

thanks,

greg k-h


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id\x14396&op=click
_______________________________________________
Linux-hotplug-devel mailing list  http://linux-hotplug.sourceforge.net
Linux-hotplug-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: Nomenclature of udev documentation

[Christopher Culver]

Still, if there's no great obstacle to changing the file name, then it
should be done just to have consistency with other applications. It
isn't just a GNU thing, most open source applications follow this
nomenclature. Why be different?

Christopher Culver

From: Greg KH <greg@kroah.com>
> udev has _nothing_ to do with GNU traditions, nor the Free Software
> project, with the exception being that it uses the GPL v2 for its
> license.
> 
> The file, ChangeLog, is automatically generated by the same script that
> generates the Linux Kernel ChangeLog comments that get posted to the
> linux-kernel mailing list with each kernel release.  That is why I
> chose that format.
> 
> Also, the format you are specifying, lends itself to being created by
> cvs.  udev uses BitKeeper for its version control system, which is
> vastly different.
> 
> I, however, am very happy that you enjoy the udev program so much that
> the only thing wrong you can find with it is the format that the
> ChangeLog file is in :)


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id\x14396&op=click
_______________________________________________
Linux-hotplug-devel mailing list  http://linux-hotplug.sourceforge.net
Linux-hotplug-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: Nomenclature of udev documentation

[Greg KH]

A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing on usenet and in e-mail?

A: No.
Q: Should I include quotations after my reply?


On Thu, Feb 10, 2005 at 06:58:15PM -0600, Christopher Culver wrote:
> Still, if there's no great obstacle to changing the file name, then it
> should be done just to have consistency with other applications. It
> isn't just a GNU thing, most open source applications follow this
> nomenclature. Why be different?

What program is breaking because of this?  Who is possibly
inconvenienced from it?

thanks,

greg k-h


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id\x14396&op=click
_______________________________________________
Linux-hotplug-devel mailing list  http://linux-hotplug.sourceforge.net
Linux-hotplug-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel

Re: Nomenclature of udev documentation

[Ken Brush]

On Thu, 10 Feb 2005 17:36:01 -0600 (CST), Christopher Culver
<christopher_culver@yahoo.com> wrote:
> Udev comes with a "ChangeLog" file. However, the contents of this file
> are a friendly summary of changes instead of the very specific and
> technical remarks usually contained in file of that name. According to
> the GNU tradition of documentation, now upheld by most Free Software
> project, this file would more appropriately be called NEWS. I request
> that the maintainers change the name of this file, since consistency
> is good.
> 

Looks like a Changelog to me. 

Usually the NEWS file doesn't list changes per user,  but an overview of 
features added and bugs fixed sans submitter.

Whereas, a Changelog shows bugs fixed and features added, by submitter.

-Ken


-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id\x14396&op=click
_______________________________________________
Linux-hotplug-devel mailing list  http://linux-hotplug.sourceforge.net
Linux-hotplug-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel