Page MenuHomeFreeBSD

ddb(4): improve wording
ClosedPublic

Authored by imp on Jan 11 2016, 5:07 PM.
Tags
None
Referenced Files
Unknown Object (File)
May 3 2024, 7:53 AM
Unknown Object (File)
May 3 2024, 7:53 AM
Unknown Object (File)
May 3 2024, 7:53 AM
Unknown Object (File)
May 3 2024, 7:53 AM
Unknown Object (File)
May 3 2024, 3:15 AM
Unknown Object (File)
Apr 26 2024, 6:10 PM
Unknown Object (File)
Apr 26 2024, 6:09 PM
Unknown Object (File)
Feb 23 2024, 3:44 PM
Subscribers

Details

Summary

Half of this has already been committed. Include wblock's changes that I somehow overlooked when this was originally done.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

imp retitled this revision from to Document how to enter the debugger here..
imp updated this object.
imp edited the test plan for this revision. (Show Details)
ian added a reviewer: ian.
ian added a subscriber: ian.
ian added inline comments.
share/man/man4/ddb.4
1545

I would switch word order here to smooth the sentence flow...

... can be difficult to arrange in some setups, however, so ...

This revision is now accepted and ready to land.Jan 11 2016, 5:11 PM
imp edited edge metadata.

Better wording inspired by Ian.

This revision now requires review to proceed.Jan 11 2016, 5:59 PM
wblock added inline comments.
share/man/man4/ddb.4
1530

s/IMPI/IPMI/

1538

Avoid "you", and try to clear up the last part of the sentence:

Serial consoles can break to the debugger by sending a BREAK
condition on the serial line.  This requires a kernel built with
.Cd options BREAK_TO_DEBUGGER .
1543

s/or via a//

1550

This sentence is very long and difficult to follow. Best to split it up into shorter sentences.

Sending the break can be difficult or even happen spuriously in some setups.
An alternate method is to build a kernel with
.Cd options ALT_BREAK_TO_DEBUGGER .
With that kernel, the sequence of CR TILDE CTRL-B enters the debugger,
CR TILDE CTRL-P causes a panic instead of entering the ​debugger, and
CR TILDE CTRL-R causes an immediate reboot.
1551
In all these sequences, CR represents a Carriage Return and is usually
sent by pressing the Enter or Return key.
1554
CTRL-x is Control x, sent by pressing the Control key, then x, then releasing both.

There probably should be some markup on "x" to represent the key, also on the tilde in the previous sentence.
At this moment, I don't know exactly what that should be (brain is in a different namespace right now).

1557

s/may/can/, also use a compound adjective, and the final "the" is probably not needed:

The break-to-debugger behavior can also be enabled by setting
1561

As above:

The alt-break-to-debugger behavior can also be enabled by setting
1565
The debugger can be entered by setting
imp retitled this revision from Document how to enter the debugger here. to ddb(4): improve wording.Jul 9 2021, 7:49 AM
imp edited the summary of this revision. (Show Details)
imp edited reviewers, added: bcr; removed: ian.
This revision was not accepted when it landed; it landed in state Needs Review.Jul 12 2021, 9:14 PM
Closed by commit rGdc5a0d6d6d0c: ddb(4): improve wording (authored by imp). · Explain Why
This revision was automatically updated to reflect the committed changes.