* The build docs often refer to "filetype commands" or "independent commands" when they mean *build* commands. Clarify these. (This is useful anyway, but particularly if I/we finish #2307) * Fix some uses of "Build Menu Commands dialog" when it should be "Set Build Commands dialog". * Various tweaks to aid reading. Remove some unnecessary paragraph breaks. You can view, comment on, or merge this pull request online at:
https://github.com/geany/geany/pull/2326
-- Commit Summary --
* docs: Clarify that "filetype & independent commands" mean build commands * Tweak build docs * Rename superseded "Build menu commands" command to "Set Build Commands"
-- File Changes --
M doc/geany.txt (117)
-- Patch Links --
https://github.com/geany/geany/pull/2326.patch https://github.com/geany/geany/pull/2326.diff
@ntrel pushed 1 commit.
48d25ffc08e8e60c279b93adbbd771d18ef517e6 Clarify editing build commands from preferences
@ntrel pushed 1 commit.
f5754ac2ce263e43ad530f45f56c49ab641ded11 Clarify editing build commands from preferences
@ntrel pushed 1 commit.
7f0eb45c209b3043d3800b62f35ae8d64af542b5 Break long lines
@ntrel pushed 1 commit.
5f0df3d7d04d5aa9c908c99af23723188320382b Break long lines
codebrainz approved this pull request.
I like these changes, just the list nesting comment I think is an actual problem.
@@ -3042,16 +3039,16 @@ behaviors:
compiler tab and parse it for errors. * Execute commands - are configurable and intended for executing your program or other long running programs. The output is not parsed for errors - and is directed to the terminal command selected in preferences. + and is directed to the terminal command selected in *Preferences*.
Alternative for `*Preferences*` could be `` `Tools preferences`_ ``.
- Fixed commands - these perform built-in actions:
- * Go to the next error. - * Go to the previous error. - * Show the build menu commands dialog. +* Go to the next error. +* Go to the previous error. +* Show the build menu commands dialog.
I think this indentation was intentional for nesting.
execute and preferences independent execute commands can only be set by hand
editing the appropriate file, see `Preferences file format`_ and `Project file format`_.
-Build menu commands dialog -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Most of the configuration of the build menu is done through the Build Menu -Commands Dialog. You edit the configuration sourced from preferences in the -dialog opened from the Build->Build Menu Commands item and you edit the -configuration from the project in the build tab of the project preferences -dialog. Both use the same form shown below. +Set Build Commands dialog +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Most of the configuration of the build menu is done through the *Set +Build Commands* dialog. When no project is open, you can edit the
Could use `` `Set Build Commands dialog`_ `` or whatever is the hyperlink syntax.
An item with an empty label will not be shown in the menu.
-
If merging into a single paragraph, a reflow of the new paragraph might be in order, not a big deal though.
The only problem I have (which is not caused by these changes) is that "Build" is rather overused, we have "Build" menus and "Build commands" and one of the filetype specific defaults is called "Build" and at times I'm sure people are confused which is being referenced.
@ntrel pushed 1 commit.
687855b65f9712575e55f0c7b911ea1dc96321a4 review tweaks
ntrel commented on this pull request.
- Fixed commands - these perform built-in actions:
- * Go to the next error. - * Go to the previous error. - * Show the build menu commands dialog. +* Go to the next error. +* Go to the previous error. +* Show the build menu commands dialog.
Yes. BTW the restructuredtext indent should go after the `*`: ``` * Go to the next error ``` otherwise it gets shown in a box with green background. But for now I reverted this, it's fixed differently in #2307.
ntrel commented on this pull request.
An item with an empty label will not be shown in the menu.
-
I've not done this, ideally yes. I prefer not to reflow too often otherwise the history/diff can introduce more conflicts.
I added all the suggestions except reflowing joined paragraphs.
codebrainz commented on this pull request.
- Fixed commands - these perform built-in actions:
- * Go to the next error. - * Go to the previous error. - * Show the build menu commands dialog. +* Go to the next error. +* Go to the previous error. +* Show the build menu commands dialog.
It shows correctly here after the revert.
codebrainz commented on this pull request.
An item with an empty label will not be shown in the menu.
-
Since the `.txt` file is also meant to be read directly (ex. it's installed into docs directory), IMO it's a worthwhile tradeoff to reflow, but again not a big deal.
ntrel commented on this pull request.
- Fixed commands - these perform built-in actions:
- * Go to the next error. - * Go to the previous error. - * Show the build menu commands dialog. +* Go to the next error. +* Go to the previous error. +* Show the build menu commands dialog.
Ok, weird. It looks right here too: https://www.geany.org/manual/dev/index.html#build-menu-configuration
Anyway, I broke up the list in the other pull so that's still valid either way.
The only problem I have (which is not caused by these changes) is that "Build" is rather overused
True, I suppose the build/compile commands and the run commands could collectively be called spawn commands. Not sure whether to do this though.
@ntrel pushed 1 commit.
54f87a28e579d6a5fbb3e21c46fd2f115dbb8b56 Wrap joined paragraphs
ntrel commented on this pull request.
An item with an empty label will not be shown in the menu.
-
OK, wrapped.
Merged #2326 into master.
github-comments@lists.geany.org