Decoded-GNU-Coreutils comment repo

This repo contains the comments used to generate the line-by-line walkthroughs for the Decoded: GNU coreutils project.

The .comment files are skeletons to fill in over time. These .comment files are combined with the source from my mirror of the v8.3 source and generated markup on the website.

For example: The whoami source is combined with the whoami.comments file and the resulting walkthrough is generated on my website via some server-side scripting magic. (magic not included in this repo)

As of August 2019, only 'whoami' has any useful contributions. All others are utilities are placeholders that are generated, but mostly useless. Such as: tee, timeout

Files

In addition to .comment files there are three other special files tha contain common elements used among all utilities:

!syscalls
!includes
!common

Entries in these files will apply to occurrances across all utilties. However, these can be overrided by adding the line manually to the specific utility

Usage

Look at the .comment files to see how they work. For now, the 'whoami' comments and results are the model to use. In general, a line number and a comment on a single line.

The only markup current supported is a double space forces a new line. I may make this more complicated as time goes by...or maybe not. KISS

Contributions

Feel free to contribute although I admit this is a huge workload and quite boring. I'll knock it out myself over the long haul

Some of the placeholder .comment files don't line up well with the source code (such as 'ptx'). These were generated with a quick and dirty parser rather than a general yacc/flex/bison solution. Since all files require going through by hand, I'll fix them when the time comes.

NOTE: Updating this repo does not immediately update the website. I have to cast the spells manually for now.