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

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

  • Comments

    • jdelvare
      6 months 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.

    • jdelvare
      5 months ago by jdelvare | Reply

      After another round trip, the final series was committed on August 3rd, 2022.

    Similar Projects

    This project is one of its kind!