Project Description

Back in June 2018, G. Branden Robinson submitted a 26-patch series intending to fix quilt's manual page, addressing both contents and technical issues with the roff formatting. I went through the whole series and reviewed it carefully. I recall I had many objections so there was a significant amount of work needed, including reordering some of the patches, before resubmitting a patch series I would consider committing. Unfortunately, the contributor vanished before resubmitting, and all the work from both sides went to oblivion. This week I would like to resume working on this to finally get something real done out of the time I invested back then.

Goal for this Hackweek

The roadmap would look like this:

  • Rebase the patch series on top of the current quilt source tree.
  • Read the whole discussion that happened back then: the original submission, my comments, and the feedback from my comments.
  • Decide what to do with the comments and feedback (I may have changed opinions since then).
  • Update the whole series in a way that would make me-the-reviewer happy, and resubmit.

There's also a longer-term goal of learning the best practice of man page formatting and contents, so that I can maybe apply some of it to the manual pages of the other tools I am maintaining.

Resources

Upstream submission on the quilt-dev list

Looking for hackers with the skills:

quilt documentation

This project is part of:

Hack Week 21

Activity

  • about 1 month ago: dsterba liked this project.
  • about 1 month ago: dirkmueller left this project.
  • about 1 month ago: dirkmueller joined this project.
  • about 1 month ago: jdelvare started this project.
  • about 1 month ago: jdelvare added keyword "documentation" to this project.
  • about 1 month ago: jdelvare added keyword "quilt" to this project.
  • about 1 month ago: jdelvare originated this project.

  • Comments

    • jdelvare
      9 days ago by jdelvare | Reply

      On July 26th, I posted an updated patch series for review. Branden had a few more comments which I addressed today.

    Similar Projects

    Learn to do 3D animations for product documentation in Blender by rainerkoenig

    [comment]: # (Please use the project descriptio...


    Blog about our ScummVM Freeware games packages by sndirsch

    Blog about ScummVM Freeware games of our open...


    Refresh the internal SUSE Manager maintenance documentation by deneb_alpha

    Project Description

    With this project I wou...


    EVERYONE can contribute to documentation – See how YOU can join the party by chabowski

    [comment]: # (Please use the project descriptio...


    awesome open source by hennevogel

    There are tons of [awesome lists](https://githu...