taskGNU Astronomy Utilities - Tasks: task #13898, List of documentation authors at...

 
 

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

task #13898: List of documentation authors at start

Submitter:  Mohammad Akhlaghi <makhlaghi>
Submitted:  Wed 17 Feb 2016 07:12:54 AM UTC
   
 
Should Start On:  Tue 16 Feb 2016 03:00:00 PM UTC Should be Finished on:  Tue 16 Feb 2016 03:00:00 PM UTC
Category:  Book Priority:  5 - Normal
Item Group:  Enhancement Status:  Done
Privacy:  Public Assigned to:  makhlaghi
Percent Complete:  100% Open/Closed:  Closed
Effort:  0.00

Sun 01 May 2016 05:55:07 AM UTC, comment #4: 

I forgot to update the task headers. They are now updated.

Even though it is marked as complete, the discussions below are most welcome.

Mohammad Akhlaghi <makhlaghi>
Group administrator
Sun 01 May 2016 05:53:05 AM UTC, comment #3: 

Thanks, the issue is now implemented.

During my work on the bootstrap process (task #13778), I done a similar job. The AUTHORS file is now automatically generated from the version controlled history using the "genauthors" script. genauthors is called by both the bootstrap.conf and any "dist" make rule (for example "make dist" or "make distcheck" in the top Makefile.am). I used a similar mechanism to implement this task.

At first I wanted to use "git --log" as you suggested, but then found out that Git has a better solution (shortlog):


git shortlog --numbered --summary --email


It is now directly called from within doc/Makefile.am which (after some short formatting) genrates an "authors.texi" file that is included in gnuastro.texi.

I also thought that since the documentation is not separate from the software (as discussed in "Science and its tools"), all the contributions to the whole project should be considered, not just those to the manual.

These issues (including all contributions, including the commit numbers and emails, sorting and etc..) are all open to discussion, so please feel free to suggest alternatives or additions. For example we can also include the author institutions if it is agreed upon.

Mohammad Akhlaghi <makhlaghi>
Group administrator
Sun 01 May 2016 12:04:52 AM UTC, comment #2: 

Oops, I missed to add that to have the sorted list of authors one should send the output of git log to sort:


git log --format="%aN" -- doc/*.texi | sort -u


Mosè Giordano <giordano>
Group Member
Sat 30 Apr 2016 01:58:31 PM UTC, comment #1: 

Something like


git log --format="%aN" -- doc/*.texi


should do the trick

Mosè Giordano <giordano>
Group Member
Wed 17 Feb 2016 07:12:54 AM UTC, original submission:  

It is very important to list all the people that have done any kind of change in the documentation. This is a more general list of committers than task #13897 (making a revision history).

While that revision history might best be placed in the end of the documentation, this list must be put in the first few pages (maybe it can fill the top of the copyright page).

We can generate this list automatically using the git log. The authors can be ordered based on the amount they have contributed.

Mohammad Akhlaghi <makhlaghi>
Group administrator

 

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

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by giordano (Posted a comment)
  • -email is unavailable- added by makhlaghi (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 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2016-05-01 makhlaghi StatusPostponed Done
        Percent Complete0% 100%
        Assigned toNone makhlaghi
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code