Opened 3 years ago

Last modified 3 years ago

#13262 assigned bug

Default Debugger actions file should be documented somewhere

Reported by: KapiX Owned by: anevilyak
Priority: normal Milestone:
Component: Documentation Version:
Keywords: Cc:
Blocked By: Blocking:
Has a Patch: no Platform: All

Description

I have just spent too much time looking for that information in Google.

http://cgit.haiku-os.org/haiku/commit/?id=hrev46547

However, user guide states "Describing the usage of the actual Debugger is out of scope for this guide that is addressing the needs of the common user of Haiku.", but later "As there's not a single document explaining the intricacies of Haiku's Debugger, below are a few links that may shed some light."

Where should that documentation be located then? Wasting 20 minutes to find a link to that information is frustrating.

Change History (6)

comment:1 by KapiX, 3 years ago

Also link to Rene's blogposts in Debugger user guide page is broken.

comment:2 by humdinger, 3 years ago

Owner: changed from nielx to anevilyak
Status: newassigned

I still think the details of how to use the Debugger is not suited for the user guide. Rene's debugger manual already has 33 pages. Shall I add your found commit message to the short list of links on that user guide page?
I corrected the link to Rene's blogs, thanks! That, as well as the already some time ago added link to the Debugger manual will be available once the user guide is exported again. Can anyone do that please?

Just to annoy Rene, I assign the ticket to him, so he might add the info of that commit message to the manual. :)

comment:3 by KapiX, 3 years ago

I completely forgot that there was a manual. If that info is going to end up in that manual, then additional link in user guide is not necessary.

I'd argue however that after all I am a user of the Debugger, so details of how to use the Debugger do belong in the User Guide. First thing I thought to do was to look there, though if the links were there this ticket wouldn't exist. I see your point, but I think it's like arguing there should be another man tool specifically for commands that developers would use.

comment:4 by anevilyak, 3 years ago

As a counterpoint though, development tools (which the debugger unquestionably is) aren't generally something an average end user is going to touch, so they do seem arguably out of scope for a user guide that's aimed more at the latter, which ours is. As such, it's linked in the development section of the website [1], which I'd argue isn't unreasonable. We aren't Linux, and we're not assuming every end user is a dev, or has anywhere near that knowledge set.

[1] https://www.haiku-os.org/development/

comment:5 by humdinger, 3 years ago

The link to the Debugger manual is in the user guide. I just wasn't able to find someone that could export it for the past months...

I'm not enough a programmer to speak confidently about using the Debugger. If anyone wants to address the details about using Debugger that's not covered in the Debugger manual, submit your first draft.

in reply to:  4 comment:6 by KapiX, 3 years ago

Replying to anevilyak:

As a counterpoint though, development tools (which the debugger unquestionably is) aren't generally something an average end user is going to touch

Then why is it even mentioned there?

As such, it's linked in the development section of the website [1], which I'd argue isn't unreasonable.

Looks like I fell into the trap of looking at Google, which is absolute crap when searching for anything related with Haiku. It doesn't help that if you search for Debugger on haiku-os.org the first link is the user guide...

Note: See TracTickets for help on using tickets.