BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
This task involves writing basic documentation for '''JUST ONE''' of those commands in the Docbook XML format. Pick one (at random). Spend a few minutes learning how to use the tool, read the soure code for hints, then write a basic manual page for it. The command documentation should provide a one-sentence description, a detailed description (200+ words), explanation of '''all''' available command-line options, and one or two examples on how to use the command.
Code:
- doc/docbook/system/man1/en/Makefile.am
- doc/docbook/system/man1/en/*.xml
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| http://sourceforge.net/p/brlcad/patches/244/ | n/a | December 03 2013 13:50 UTC | |
| http://sourceforge.net/p/brlcad/patches/244/ | n/a | December 06 2013 14:54 UTC |
how can i find out about the command? so i can write about one? where could i find info on it?
I would like to work on this task.
This task has been assigned to Shardul Chiplunkar. You have 72 hours to complete this task, good luck!
Is rtexample still available? Also, do I write a man page first and then convert it to Docbook XML format (how?) or do I directly write the XML file? Thanks for your attention!
The work on this task is ready to be reviewed.
Shardul, you're right on track and glad you found the other xml files similar to what you need to edit. Yours looks good and is almost sufficient. It just fails to pass validation:
[ 88%] Generating ../../../../../share/man/man1/rtexample.1
Note: meta source : no *info/productname or alternative rtexample
Note: meta source : see http://docbook.sf.net/el/productname rtexample
Note: meta source : no refentry/refmeta/refmiscinfo@class=source rtexample
Note: meta source : see http://docbook.sf.net/el/refmiscinfo rtexample
Note: meta version: no *info/productnumber or alternative rtexample
Note: meta version: see http://docbook.sf.net/el/productnumber rtexample
Note: meta version: no refentry/refmeta/refmiscinfo@class=version rtexample
Note: meta version: see http://docbook.sf.net/el/refmiscinfo rtexample
Warn: meta source : using "December 2, 2013" for "source" rtexample
Warn: meta author : no refentry/info/author rtexample
Note: meta author : see http://docbook.sf.net/el/author rtexample
Warn: meta author : no author data, so inserted a fixme rtexample
One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.
Melange has detected that the final deadline has passed and it has reopened the task.
I got what I need to do, but the time seems to have finished. Can I claim the same task again or take another BRL-CAD documentation task?
Since the task is not closed yet, you are welcome to claim it.
if you want to finish your work.
I would like to work on this task.
This task has been assigned to Shardul Chiplunkar. You have 72 hours to complete this task, good luck!
The work on this task is ready to be reviewed.
Please see the second uploaded patch file, it contains the changes. Thanks!
The latest patch passes validation. The author and copyright fields weren't right, but they were fixed in a subsequent commit. You can research what those fixes were if you'd like to learn, but you've accomplished the primary goals of this GCI task. You've been credited in our authorship documentation with this contribution. Thanks for your hard work!
Congratulations, this task has been completed successfully.
Shardul, want to let you know that you are just one task shy of getting a t-shirt from Google for having completed three tasks. Thank you for your efforts!