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 3 years ago: dsterba liked this project.
  • about 3 years ago: dirkmueller left this project.
  • about 3 years ago: dirkmueller joined this project.
  • about 3 years ago: jdelvare started this project.
  • about 3 years ago: jdelvare added keyword "documentation" to this project.
  • about 3 years ago: jdelvare added keyword "quilt" to this project.
  • about 3 years ago: jdelvare originated this project.

  • Comments

    • jdelvare
      about 3 years 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
      about 3 years ago by jdelvare | Reply

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

    Similar Projects

    Advent of Code: The Diaries by amanzini

    Description

    It was the Night Before Compile Time ...

    Hackweek 25 (December 1-5) perfectly coincides with the first five days of Advent of Code 2025. This project will leverage this overlap to participate in the event in real-time.

    To add a layer of challenge and exploration (in the true spirit of Hackweek), the puzzles will be solved using a non-mainstream, modern language like D, Crystal, Gleam or Zig.

    The primary project intent is not just simply to solve the puzzles, but to exercise result sharing and documentation. I'd create a public-facing repository documenting the process. This involves treating each day's puzzle as a mini-project: solving it, then documenting the solution with detailed write-ups, analysis of the language's performance and ergonomics, and visualizations.

                                   |
                                 \ ' /
                               -- (*) --
                                  >*<
                                 >0<@<
                                >>>@<<*
                               >@>*<0<<<
                              >*>>@<<<@<<
                             >@>>0<<<*<<@<
                            >*>>0<<@<<<@<<<
                           >@>>*<<@<>*<<0<*<
             \*/          >0>>*<<@<>0><<*<@<<
         ___\\U//___     >*>>@><0<<*>>@><*<0<<
         |\\ | | \\|    >@>>0<*<0>>@<<0<<<*<@<<
         | \\| | _(UU)_ >((*))_>0><*<0><@<<<0<*<
         |\ \| || / //||.*.*.*.|>>@<<*<<@>><0<<<
         |\\_|_|&&_// ||*.*.*.*|_\\db//_
         """"|'.'.'.|~~|.*.*.*|     ____|_
             |'.'.'.|   ^^^^^^|____|>>>>>>|
             ~~~~~~~~         '""""`------'
    ------------------------------------------------
    This ASCII pic can be found at
    https://asciiart.website/art/1831
    
    

    Goals

    Code, Docs, and Memes: An AoC Story

    • Have fun!

    • Involve more people, play together

    • Solve Days 1-5: Successfully solve both parts of the Advent of Code 2025 puzzles for Days 1-5 using the chosen non-mainstream language.

    • Daily Documentation & Language Review: Publish a detailed write-up for each day. This documentation will include the solution analysis, the chosen algorithm, and specific commentary on the language's ergonomics, performance, and standard library for the given task.