Add missing documentation (for any ONE command) #3

Add missing documentation (for any ONE command) #3BRL-CAD

Status: ClosedTime to complete: 72 hrs Mentors: SeanTags:

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

Uploaded Work

File name/URL	File size	Date submitted
patch.patch	2.8 KB	December 12 2013 12:06 UTC
patch.patch	3.1 KB	December 14 2013 09:30 UTC

Comments

Yatharth Agarwalon November 18 2013 18:09 UTCTask Claimed

I would like to work on this task.

Yatharth Agarwalon November 18 2013 18:10 UTCClaim Removed

The claim on this task has been removed, someone else can claim it now.

Yatharth Agarwalon November 18 2013 18:30 UTCTask Claimed

I would like to work on this task.

Mandeep Kaur on November 18 2013 18:32 UTCTask Assigned

This task has been assigned to Yatharth Agarwal. You have 72 hours to complete this task, good luck!

Yatharth Agarwalon November 18 2013 18:35 UTCasc2g available?

I would like to document the asc2g function for this task. If not that, then the a-d one. The task description mentioned to make sure the commands haven't been already taken, so I want to know: Can I work on those?

Yatharth Agarwalon November 18 2013 19:20 UTCClaim Removed

The claim on this task has been removed, someone else can claim it now.

Sean on November 18 2013 21:44 UTCboth

I believe they are both available, but you'll know by looking in the source distribution for the corresponding documentation file that you'd be creating.

mandaron December 8 2013 07:17 UTCTask Claimed

I would like to work on this task.

Mandeep Kaur on December 8 2013 07:56 UTCTask Assigned

This task has been assigned to mandar. You have 72 hours to complete this task, good luck!

mandaron December 8 2013 08:32 UTCClaim Removed

The claim on this task has been removed, someone else can claim it now.

mandaron December 8 2013 08:34 UTCTask Claimed

I would like to work on this task.

mandaron December 8 2013 08:43 UTCwdb_example available?

Is the wdb_example command available?

erikg on December 8 2013 23:11 UTCTask Assigned

This task has been assigned to mandar. You have 72 hours to complete this task, good luck!

erikg on December 8 2013 23:12 UTCre: wdb_example available?

wdb_example is available at src/proc-db/wdb_example.c

erikg on December 8 2013 23:13 UTCre: wdb_example available?

(and there is no documentation for wdb_example at doc/docbook/system/man1/en/wdb_example.xml yet)

mandaron December 10 2013 12:36 UTCOptions?

The file 'wdb_example' does not list any options for the command. Also, I am a bit confused about the .g file. What do I do?

Thanks for the attention!

mandaron December 10 2013 15:24 UTCHow/What to submit?

How and what do I submit? I have made the xml file and made the required changes to the CMakeList.txt

Melange on December 11 2013 23:11 UTCInitial Deadline passed

Melange has detected that the initial deadline has passed and it has set the task status to ActionNeeded. The student has 24 hours to submit the work before the task is reopened and sent back to the pool for other students to claim.

Daniel Rossberg on December 12 2013 14:20 UTCHow to submit

You should create a patch file (svn diff command from the BRL-CAD sources root directory) and upload it to this task.

Daniel Rossberg on December 12 2013 14:21 UTCDeadline extended

The deadline of the task has been extended with 1 days and 0 hours.

mandaron December 13 2013 03:32 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 13 2013 06:57 UTCclose

You are close, but more work is needed. The file is missing some critical elements:

[ 30%] Generating ../../../../../share/man/man1/wdb_example.1
Note: meta source : no *info/productname or alternative            wdb_example
Note: meta source : see http://docbook.sf.net/el/productname       wdb_example
Note: meta source : no refentry/refmeta/refmiscinfo@class=source   wdb_example
Note: meta source : see http://docbook.sf.net/el/refmiscinfo       wdb_example
Note: meta version: no *info/productnumber or alternative          wdb_example
Note: meta version: see http://docbook.sf.net/el/productnumber     wdb_example
Note: meta version: no refentry/refmeta/refmiscinfo@class=version  wdb_example
Note: meta version: see http://docbook.sf.net/el/refmiscinfo       wdb_example
Warn: meta source : using "December 2, 2013" for "source"          wdb_example
Warn: meta author : no refentry/info/author                        wdb_example
Note: meta author : see http://docbook.sf.net/el/author            wdb_example
Warn: meta author : no author data, so inserted a fixme            wdb_example

You can observe those error messages if you try to build your new documentation file (via "make" on *nix platforms). Look at the other .xml files in the same directory as the one you added for many many examples. Those messages indicate you're missing source/authorship information, but you should look through the other files to see if you're missing anything else too.

Sean on December 13 2013 06:57 UTCTask Needs More Work

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.

Sean on December 13 2013 06:57 UTCDeadline extended

The deadline of the task has been extended with 1 days and 0 hours.

Sean on December 14 2013 03:57 UTCDeadline extended

The deadline of the task has been extended with 1 days and 0 hours.

mandaron December 14 2013 09:30 UTCReady for review

The work on this task is ready to be reviewed.

mandaron December 14 2013 09:33 UTCReady for review

Please review patch set 2 subitted.

Sean on December 14 2013 15:21 UTClooks good

Mandar, your patch looks good now, nicely done. If you provide your full name, we'll credit you in our authorship documentation appropriately. Thank you for your efforts!

Your patch was applied in r58928

Sean on December 14 2013 15:22 UTCTask Closed

Congratulations, this task has been completed successfully.

mandaron December 15 2013 05:35 UTCthanks

Thank you and my full name is Mandar N Juvekar