Ticket #592 (new roadmap)

Opened 12 years ago

Last modified 10 years ago

Add documentation for parrot_debugger

Reported by: allison Owned by: allison
Priority: normal Milestone: 2.5
Component: docs Version:
Severity: medium Keywords: debugger
Cc: Language:
Patch status: Platform:

Description (last modified by dukeleto) (diff)

Add documentation for the PIR debugger, 'parrot_debugger'. We need more examples.

Change History

  Changed 11 years ago by allison

  • milestone changed from 1.4 to 1.7

in reply to: ↑ description   Changed 11 years ago by dukeleto

  • owner set to dukeleto
  • status changed from new to assigned

Replying to allison:

Add documentation for the PIR debugger, 'parrot_debugger'.

What kind of documentation is wanted? Is there other currently existing docs that can be used as a reference guide for the style and format?

  Changed 11 years ago by dukeleto

  • description modified (diff)
  • summary changed from pir debugger, docs to Add documentation for parrot_debugger

  Changed 11 years ago by dukeleto

  • component changed from none to docs
21:00:55 < dukeleto> chromatic: i think if someone could tell me what they wanted to see in the debugger docs, i could 'finish' the task, but right now, it 
                     is ambiguously specc'ed
21:01:17 < chromatic> Do you have a list of tasks you can perform in the debugger?  We could brainstorm some use cases.
21:01:23 < allison> dukeleto: focus on helping people getting started in using it
21:01:52 < dukeleto> allison: ok, I think we definitely need more of a debugger "user guide" than a manual page. good idea
21:02:01 < pmichaud> dukeleto++
21:02:20 < chromatic> japhb, seed libraries?
21:02:30 < allison> dukeleto: a short manpage is also good (so we can ship it with the distros), but that should be fast

  Changed 11 years ago by dukeleto

Currently we have three places with various types of parrot_debugger documentation : src/parrot_debugger.c (run time flag docs) src/debug.c (docs for interactive debugger use and internals docs) and docs/debugger.pod . A list of things that you can do in the debugger is in docs/debugger.pod as well as from typing "help" while in the debugger.

Allison said that she wants a short man page-like thing that can be installed for distros and pmichaud liked the idea of a "user guide." Where should these live? Also, should all of the docs inside the C files be moved somewhere more useful? It is POD, but nothing extracts it and puts it where mere mortals would find it useful.

  Changed 11 years ago by dukeleto

  • milestone 1.7 deleted

  Changed 11 years ago by allison

  • milestone set to 2.2

  Changed 11 years ago by allison

  • owner changed from dukeleto to allison
  • status changed from assigned to new
  • milestone changed from 2.2 to 2.3

Need to check that we have an adequate manpage for 2.3 release.

  Changed 11 years ago by gerd

  • milestone changed from 2.3 to 2.4

  Changed 11 years ago by gerd

  • milestone changed from 2.4 to 2.5

  Changed 10 years ago by jkeenan

  • keywords debugger added
Note: See TracTickets for help on using tickets.