#1922: Review Parrot's 'make help'
---------------------+------------------------------------------------------
Reporter: jkeenan | Owner: jkeenan
Type: cage | Status: new
Priority: normal | Milestone:
Component: docs | Version: 2.10.0
Severity: low | Keywords:
Lang: | Patch:
Platform: |
---------------------+------------------------------------------------------
When a Parrot developer invokes `make help`, slightly over 100 lines are
printed to STDOUT. Most of those lines describe various make targets.
However, it has been a long time since these targets were reviewed for the
following qualities:
* '''Existence:''' Does a particular target listed in help actually
still exist in ''Makefile''?
* '''Functionality:''' Does a particular target still work as
documented?
* '''Accuracy:''' Does the help message really describe what the
target does?
* '''Absence:''' Are there targets in ''Makefile'' which are not
listed in help but which ought to be?
We need a report which evaluates Parrot's `make help` with respect to the
qualities listed above -- and any other relevant qualities. The report
should appear in a plain-text file attached to this ticket.
The report may be accompanied as appropriate by patches to
''config/gen/makefiles/root.in'' and other files in Parrot's configuration
system used to generate the ''Makefile''.
This ticket will be offered as a Google Code-In task.
Thank you very much.
kid51
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/1922>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
