Branch: refs/heads/build-exec
Author: Nick Treleaven <n(a)trelsoft.com>
Committer: Nick Treleaven <n(a)trelsoft.com>
Date: Sat, 05 Oct 2019 11:31:09 UTC
Commit: 381024d333984ddf8854db9e1d8402159d0b7668
https://github.com/geany/geany/commit/381024d333984ddf8854db9e1d8402159d0b7…
Log Message:
-----------
Update docs for independent execute
Reword build menu configurable groups paragraph.
Modified Paths:
--------------
doc/geany.txt
Modified: doc/geany.txt
65 lines changed, 35 insertions(+), 30 deletions(-)
===================================================================
@@ -2651,7 +2651,7 @@ number_ft_menu_items The maximum number of menu items in the 2
number_non_ft_menu_items The maximum number of menu items in the 3 on restart
independent build section.
number_exec_menu_items The maximum number of menu items in the 2 on restart
- execute section of the Build menu.
+ filetype execute section.
number_exec_ind_menu_items The maximum number of menu items in the 2 on restart
independent execute section.
================================ =========================================== ========== ===========
@@ -3029,24 +3029,26 @@ in to be configured. For example, if you change one of the default make
commands to run say 'waf' you can also change the label to match.
These settings are saved automatically when Geany is shut down.
-The build menu is divided into four groups of items each with different
+The build menu has four configurable groups of items each with different
behaviors:
-* Filetype build commands - are configurable and depend on the filetype of the
- current document; they capture output in the compiler tab and parse it for
+- *Filetype build commands* - these depend on the filetype of the
+ current document. They capture output in the compiler tab and parse it for
errors.
-* Independent build commands - are configurable and mostly don't depend on the
- filetype of the current document; they also capture output in the
- 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 `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.
+- *Independent build commands* - these (mostly) don't depend on the
+ current filetype. They also capture and parse the output.
+- *Filetype execute commands* - these depend on the current filetype
+ and they are 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 `Tools preferences`_.
+- *Independent execute commands* - as above but not dependent on the
+ current filetype.
+
+The menu also has fixed commands - these perform built-in actions:
+
+* Go to the next error.
+* Go to the previous error.
+* Show the build menu commands dialog.
The maximum numbers of items in each of the configurable groups can be
configured in `Various preferences`_. Even though the maximum number of
@@ -3087,15 +3089,18 @@ is shown in the following table:
| | | | | Label: Make _Object |
| | | | | Command: make %e.o |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
-| Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
-| | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
-| | filetype defined in | ~/.config/geany or else | Geany install | |
-| | project file | filetypes.xxx file in | | |
-| | | ~/.config/geany/filedefs | Saves To: as user | |
-| | Saves To: | | preferences left. | |
-| | project file | Saves To: | | |
-| | | filetypes.xxx file in | | |
-| | | ~/.config/geany/filedefs | | |
+| Filetype | Loads From: | Loads From: | Loads From: | Label: _Execute |
+| Execute | filetype setting | filetypes.xxx file in | filetypes.xxx in | Command: ./%e |
+| | stored in | ~/.config/geany/filedefs | Geany install | |
+| | project file | | | |
+| | | Saves To: Same | Saves To: as user | |
+| | Saves To: Same | | preferences left. | |
++--------------+---------------------+--------------------------+-------------------+-------------------------------+
+| Independent | Loads From: project | Loads From: | None | None |
+| Execute | file | geany.conf file in | | |
+| | | ~/.config/geany | | |
+| | Saves To: Same | | | |
+| | | Saves To: Same | | |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
The following notes on the table may reference cells by coordinate as *(group, source)*:
@@ -3116,10 +3121,9 @@ The following notes on the table may reference cells by coordinate as *(group, s
filetype-independent commands in a filetype file, this provides the ability to
define filetype dependent default menu items.
-* *(Execute, Project and Preferences)* - the project independent
- execute and preferences independent execute commands can only be set by hand
- editing the appropriate file, see `Preferences file format`_ and `Project file
- format`_.
+* Independent execute - the project and preferences independent execute
+ commands can only be set by hand editing the appropriate file, see
+ `Preferences file format`_ and `Project file format`_.
Set Build Commands dialog
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -3192,7 +3196,8 @@ Keyboard shortcuts can be defined for:
* the first two filetype build menu items
* the first three independent build menu items
-* the first execute menu item
+* the first filetype execute menu item
+* the first independent execute menu item
* the fixed menu items (Next/Previous Error, Set Commands)
In the keybindings configuration dialog (see `Keybinding preferences`_)
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Nick Treleaven <n(a)trelsoft.com>
Committer: Nick Treleaven <n(a)trelsoft.com>
Date: Sat, 05 Oct 2019 10:35:38 UTC
Commit: f2cbc85db18814eaba32515a4b7a0e31eff05c41
https://github.com/geany/geany/commit/f2cbc85db18814eaba32515a4b7a0e31eff05…
Log Message:
-----------
docs: Clarify that "filetype & independent commands" mean build commands
Also use bullet list for configurable build keybindings.
Modified Paths:
--------------
doc/geany.txt
Modified: doc/geany.txt
37 lines changed, 21 insertions(+), 16 deletions(-)
===================================================================
@@ -2647,9 +2647,9 @@ replace_and_find_by_default Set ``Replace & Find`` button as default so t
focus.
**``build`` group**
number_ft_menu_items The maximum number of menu items in the 2 on restart
- filetype section of the Build menu.
+ filetype build section of the Build menu.
number_non_ft_menu_items The maximum number of menu items in the 3 on restart
- independent section of the Build menu.
+ independent build section.
number_exec_menu_items The maximum number of menu items in the 2 on restart
execute section of the Build menu.
================================ =========================================== ========== ===========
@@ -3064,20 +3064,20 @@ be used. The sources in decreasing priority are:
* The defaults
The detailed relationships between sources and the configurable menu item groups
-is shown in the following table.
+is shown in the following table:
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
| Group | Project File | Preferences | System Filetype | Defaults |
+==============+=====================+==========================+===================+===============================+
| Filetype | Loads From: project | Loads From: | Loads From: | None |
-| | file | filetypes.xxx file in | filetypes.xxx in | |
+| Build | file | filetypes.xxx file in | filetypes.xxx in | |
| | | ~/.config/geany/filedefs | Geany install | |
| | Saves To: project | | | |
| | file | Saves to: as above, | Saves to: as user | |
| | | creating if needed. | preferences left. | |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
-| Filetype | Loads From: project | Loads From: | Loads From: | 1: |
-| Independent | file | geany.conf file in | filetypes.xxx in | Label: _Make |
+| Independent | Loads From: project | Loads From: | Loads From: | 1: |
+| Build | file | geany.conf file in | filetypes.xxx in | Label: _Make |
| | | ~/.config/geany | Geany install | Command: make |
| | Saves To: project | | | |
| | file | Saves to: as above, | Saves to: as user | 2: |
@@ -3099,25 +3099,25 @@ is shown in the following table.
| | | ~/.config/geany/filedefs | | |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
-The following notes on the table reference cells by coordinate as (group,source):
+The following notes on the table may reference cells by coordinate as *(group, source)*:
-* General - for filetypes.xxx substitute the appropriate extension for
+* Filetype filenames - for filetypes.xxx substitute the appropriate extension for
the filetype of the current document for xxx - see `filenames`_.
* System Filetypes - Labels loaded from these sources are locale sensitive
and can contain translations.
-* (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
+* *(Filetype build, Project and Preferences)* - preferences use a full
filetype file so that users can configure all other filetype preferences
as well. Projects can only configure menu items per filetype. Saving
in the project file means that there is only one file per project not
a whole directory.
-* (Filetype-Independent, System Filetype) - although conceptually strange, defining
+* *(Filetype-Independent build, System Filetype)* - although conceptually strange, defining
filetype-independent commands in a filetype file, this provides the ability to
define filetype dependent default menu items.
-* (Execute, Project File) and (Execute, Preferences) - the project independent
+* *(Execute, Project and Preferences)* - the project independent
execute and preferences independent execute commands can only be set by hand
editing the appropriate file, see `Preferences file format`_ and `Project file
format`_.
@@ -3139,7 +3139,7 @@ The dialog is divided into three sections:
* Independent build commands (available regardless of filetype).
* Filetype execute commands.
-The filetype and independent sections also each contain a field for the regular
+The filetype and independent build sections also each contain a field for the regular
expression used for parsing command output for error and warning messages.
The columns in the first three sections allow setting of the label, command,
@@ -3188,8 +3188,13 @@ before the command is run.
Build menu keyboard shortcuts
`````````````````````````````
-Keyboard shortcuts can be defined for the first two filetype menu items, the first three
-independent menu items, the first execute menu item and the fixed menu items.
+Keyboard shortcuts can be defined for:
+
+* the first two filetype build menu items
+* the first three independent build menu items
+* the first execute menu item
+* the fixed menu items (Next/Previous Error, Set Commands)
+
In the keybindings configuration dialog (see `Keybinding preferences`_)
these items are identified by the default labels shown in the `Build Menu`_ section above.
@@ -4749,8 +4754,8 @@ where:
* GG - is the menu item group,
- - FT for filetype
- - NF for independent (non-filetype)
+ - FT for filetype build
+ - NF for independent (non-filetype) build
- EX for execute
* NN - is a two decimal digit number of the item within the group,
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Nick Treleaven <n(a)trelsoft.com>
Committer: Nick Treleaven <n(a)trelsoft.com>
Date: Sat, 05 Oct 2019 10:35:38 UTC
Commit: 27f611c86d95e11e931fb5ecf2abc12831b2fe2e
https://github.com/geany/geany/commit/27f611c86d95e11e931fb5ecf2abc12831b2f…
Log Message:
-----------
Rename superseded "Build menu commands" command to "Set Build Commands"
Modified Paths:
--------------
doc/geany.txt
Modified: doc/geany.txt
39 lines changed, 18 insertions(+), 21 deletions(-)
===================================================================
@@ -2855,8 +2855,8 @@ warnings or errors are marked in the source, see `Indicators`_ below.
.. tip::
If Geany's default error message parsing does not parse errors for
- the tool you're using, you can set a custom regex in the Build Commands
- Dialog, see `Build Menu Configuration`_.
+ the tool you're using, you can set a custom regex in the
+ `Set Build Commands dialog`_, see `Build Menu Configuration`_.
Indicators
^^^^^^^^^^
@@ -2967,7 +2967,7 @@ Execute
Execute will run the corresponding executable file, shell script or
interpreted script in a terminal window. The command set in the
-"Set Build Commands" dialog is run in a script to ensure the terminal
+`Set Build Commands dialog`_ is run in a script to ensure the terminal
stays open after execution completes. Note: see `Terminal emulators`_
below for the command format. Alternatively the built-in VTE can be used
if it is available - see `Virtual terminal emulator widget (VTE)`_.
@@ -3001,8 +3001,7 @@ execute the terminal program and to pass it the name of the Geany run
script that it should execute in a Bourne compatible shell (eg /bin/sh).
The marker "%c" is substituted with the name of the Geany run script,
which is created in the temporary directory and which changes the working
-directory to the directory set in the Build commands dialog, see
-`Build menu commands dialog`_ for details.
+directory to the directory set in the `Set Build Commands dialog`_.
As an example the default (Linux) command is::
@@ -3122,14 +3121,14 @@ The following notes on the table may reference cells by coordinate as *(group, s
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.
+The configuration sourced from user preferences can be edited in the
+dialog opened from the *Build->Set Build Commands* menu item. The
+configuration sourced from the project can be edited in the *Build* tab of the `Project Properties`_
+dialog. The former menu item also shows the project dialog when a project is open. Both use the same form shown below.
.. image:: ./images/build_menu_commands_dialog.png
@@ -3212,8 +3211,7 @@ preferences and filetype file settings and will attempt to map them into the new
configuration format. There is not a simple clean mapping between the formats.
The mapping used produces the most sensible results for the majority of cases.
However, if they do not map the way you want, you may have to manually
-configure some settings using the Build Commands
-Dialog or the Build tab of the project preferences dialog.
+configure some settings using the `Set Build Commands dialog`_.
Any setting configured in either of these dialogs will override settings mapped from
older format configuration files.
@@ -4324,16 +4322,15 @@ Example::
As of Geany 0.19 this section is for legacy support.
Values that are set in the [build-menu] section will override those in this section.
+If any build menu item settings have been configured in the `Set Build Commands dialog`_ (or the *Build* tab of the `Project Properties`_ dialog), then these
+settings are stored in the [build-menu] section and will override the settings in
+this section for that item.
+
error_regex
- See [build-menu] section for details.
+ See the [build-menu] section for details.
**Build commands**
-If any build menu item settings have been configured in the Build Menu Commands
-dialog or the Build tab of the project preferences dialog then these
-settings are stored in the [build-menu] section and override the settings in
-this section for that item.
-
compiler
This item specifies the command to compile source code files. But
it is also possible to use it with interpreted languages like Perl
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Nick Treleaven <n(a)trelsoft.com>
Committer: Nick Treleaven <n(a)trelsoft.com>
Date: Sat, 05 Oct 2019 10:35:38 UTC
Commit: 38320911b1d95e48eaf706ab0eba22986528197e
https://github.com/geany/geany/commit/38320911b1d95e48eaf706ab0eba229865281…
Log Message:
-----------
Clarify editing build commands from preferences
Modified Paths:
--------------
doc/geany.txt
Modified: doc/geany.txt
9 lines changed, 5 insertions(+), 4 deletions(-)
===================================================================
@@ -3123,10 +3123,11 @@ Set Build Commands dialog
^^^^^^^^^^^^^^^^^^^^^^^^^
Most of the configuration of the build menu is done through the *Set Build Commands* dialog.
-The configuration sourced from user preferences can be edited in the
-dialog opened from the *Build->Set Build Commands* menu item. The
-configuration sourced from the project can be edited in the *Build* tab of the `Project Properties`_
-dialog. The former menu item also shows the project dialog when a project is open. Both use the same form shown below.
+When no project is open, you can edit the configuration sourced from user preferences
+using the *Build->Set Build Commands* menu item. You can edit the
+configuration sourced from a project in the *Build* tab of the `Project Properties`_
+dialog. The former menu item also shows the project dialog when a project is open.
+Both use the same form shown below.
.. image:: ./images/build_menu_commands_dialog.png
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Nick Treleaven <n(a)trelsoft.com>
Committer: Nick Treleaven <n(a)trelsoft.com>
Date: Sat, 05 Oct 2019 10:35:38 UTC
Commit: 2eedf488c1cd864aaf19aca1b0febf982891c5f6
https://github.com/geany/geany/commit/2eedf488c1cd864aaf19aca1b0febf982891c…
Log Message:
-----------
review tweaks
Modified Paths:
--------------
doc/geany.txt
Modified: doc/geany.txt
15 lines changed, 8 insertions(+), 7 deletions(-)
===================================================================
@@ -3038,13 +3038,14 @@ behaviors:
filetype of the current document; they also capture output in the
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*.
+ program or other long running programs. The output is not parsed for
+ errors and is directed to the terminal command selected in `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.
The maximum numbers of items in each of the configurable groups can be
configured in `Various preferences`_. Even though the maximum number of
@@ -3122,8 +3123,8 @@ The following notes on the table may reference cells by coordinate as *(group, s
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
+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
configuration sourced from user preferences using the *Build->Set Build
Commands* menu item. You can edit the configuration sourced from a
project in the *Build* tab of the `Project Properties`_ dialog. The
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).
Branch: refs/heads/master
Author: Nick Treleaven <n(a)trelsoft.com>
Committer: Nick Treleaven <n(a)trelsoft.com>
Date: Sat, 05 Oct 2019 10:35:38 UTC
Commit: 28defee433023f6138124983bd09c07665321ec6
https://github.com/geany/geany/commit/28defee433023f6138124983bd09c07665321…
Log Message:
-----------
Break long lines
Modified Paths:
--------------
doc/geany.txt
Modified: doc/geany.txt
24 lines changed, 14 insertions(+), 10 deletions(-)
===================================================================
@@ -3122,11 +3122,12 @@ The following notes on the table may reference cells by coordinate as *(group, s
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 configuration sourced from user preferences
-using the *Build->Set Build Commands* menu item. You can edit the
-configuration sourced from a project in the *Build* tab of the `Project Properties`_
-dialog. The former menu item also shows the project dialog when a project is open.
+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
+configuration sourced from user preferences using the *Build->Set Build
+Commands* menu item. You can edit the configuration sourced from a
+project in the *Build* tab of the `Project Properties`_ dialog. The
+former menu item also shows the project dialog when a project is open.
Both use the same form shown below.
.. image:: ./images/build_menu_commands_dialog.png
@@ -3163,8 +3164,9 @@ configure with nothing in the label but at least one character in the command.
Substitutions in commands and working directories
`````````````````````````````````````````````````
-Before the command is run, the first occurrence of each of the following two character sequences in each of the
-command and working directory fields is substituted by the items specified below:
+Before the command is run, the first occurrence of each of the following
+two character sequences in each of the command and working directory
+fields is substituted by the items specified below:
* %d - the absolute path to the directory of the current file.
* %e - the name of the current file without the extension or path.
@@ -4316,9 +4318,11 @@ Example::
As of Geany 0.19 this section is for legacy support.
Values that are set in the [build-menu] section will override those in this section.
-If any build menu item settings have been configured in the `Set Build Commands dialog`_ (or the *Build* tab of the `Project Properties`_ dialog), then these
-settings are stored in the [build-menu] section and will override the settings in
-this section for that item.
+If any build menu item settings have been configured in the
+`Set Build Commands dialog`_ (or the *Build* tab of the
+`Project Properties`_ dialog), then these settings are stored in the
+[build-menu] section and will override the settings in this section for
+that item.
error_regex
See the [build-menu] section for details.
--------------
This E-Mail was brought to you by github_commit_mail.py (Source: https://github.com/geany/infrastructure).