This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [PATCH] edit documentation for TUI mode


Eli Zaretskii wrote:
The last sentence begs a question: ``how''?  We should either answer
that right there, or have an xref to where the appropriate command is
described.

Good point. I'm not entirely sure what to do here. It would be best to specify it directly, with a cross-ref for additional info, but there appear to be a lot of different ways of switching into TUI mode. Even the "C-x C-a" key binding, which is the most straightforward and also works to switch back out of TUI mode, has 3 different variations: "C-x C-a", "C-x a" and "C-x A".


What do you think about changing that sentence as follows?

You can also switch in and out of TUI mode while @value{GDBN} runs by using various TUI commands and key bindings, such as @kbd{C-x C-a}. @xref{TUI Keys, ,
TUI Key Bindings}.



Why did you switch to `@table @asis' and an explicit @key in each
item?  What was wrong with the previous method?

The last entry, "C-L", is not a key. It needs to be formatted with @kbd. The difference doesn't matter much for Info output, but for TeX output, it is bad to have a key-shaped box with "C-L" inside it.


--Bob


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]