bugGNU gettext - Bugs: bug #59352, autosprintf.h comments

 
 

You are not allowed to post comments on this tracker with your current authentication level.

bug #59352: autosprintf.h comments

Submitter:  J <now3d>
Submitted:  Mon 26 Oct 2020 02:37:07 PM UTC
   
 
Category:  Doc Severity:  3 - Normal
Item Group:  None Status:  Answer Provided
Privacy:  Public Assigned to:  haible
Open/Closed:  Closed

Tue 27 Oct 2020 12:01:36 PM UTC, comment #4: 

You're right that before version control, people put history notes and contributors in the header more often, nowadays those comments go into the commit message. I don't feel that JPEG file is best practice. the Glibc ones are good though. Take a look at /usr/include/stdio.h

"Define ISO C stdio on top of C++ iostreams."

One clear line doesn't hurt does it?

It seems reasonable to have a few words to describe the purpose of the file as it's an interface. However, you're the maintainer, maybe close the ticket if we can't agree.


J <now3d>
Tue 27 Oct 2020 12:04:15 AM UTC, comment #3: 


> can it be updated to clarify it comes from GNU gettext?
> I've attached a patch


There's no need to.

When I look at the files in /usr/include, other than those that come from glibc, many don't have a statement where they come from.

Some do, and some even contain kind of a history. Such as

   This file is part of the GNU C Library.
   Copyright (C) 1992-2016 Free Software Foundation, Inc.
   NOTE: The canonical source of this file is maintained with the GNU cpio.

or

  This file was part of the Independent JPEG Group's software:
  Copyright (C) 1991-1998, Thomas G. Lane.
  Modified 2002-2009 by Guido Vollbeding.
  libjpeg-turbo Modifications:
  Copyright (C) 2009-2011, 2013-2014, D. R. Commander.

This is getting too verbose over time.

Also, when a package is split/recombined/forked, such a statement of origin may add confusion instead of reducing confusion.

It is best to just rely on the file inventory of the distro, may it be dpkg, rpm, zypper, yum, dnf, or whatever.

Bruno Haible <haible>
Group administrator
Mon 26 Oct 2020 10:21:11 PM UTC, comment #2: 

Hi Bruno
Many thanks for your reply.

My question is about the file /usr/include/autosprintf.h

can it be updated to clarify it comes from GNU gettext?

I've attached a patch

(file #50116)

J <now3d>
Mon 26 Oct 2020 10:04:18 PM UTC, comment #1: 


> Could this file clarify which package it comes from?


This is a question about the distro.

1) "dpkg -S /usr/include/autosprintf.h" tells you that the binary package is called 'libasprintf-dev' in this distribution.

2) A search at https://packages.ubuntu.com/ for package 'libasprintf-dev' points you to a page that the file lists and the source package for this binary package.

You find the documentation here:
https://www.gnu.org/software/gettext/libasprintf/manual/index.html

Bruno Haible <haible>
Group administrator
Mon 26 Oct 2020 02:37:07 PM UTC, original submission:  

On ubuntu I have libasprintf-dev which contains /usr/include/autosprintf.h

I understand this is from Gettext

Could this file clarify which package it comes from?

"Class autosprintf - formatted output to an ostream."

"GNU Gettext.
Class autosprintf - formatted output to an ostream."

Thank you

J <now3d>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attached Files

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by haible (Posted a comment)
  • -email is unavailable- added by now3d (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-10-26 now3d Attached File- Added 0001-Clarify-autosprintf.h-is-from-GNU-gettext.patch, #50116
    2020-10-26 haible CategoryNone Doc
    2020-10-26 haible StatusNone Answer Provided
        Assigned toNone haible
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code