diff options
Diffstat (limited to 'manual.en.html')
-rwxr-xr-x | manual.en.html | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/manual.en.html b/manual.en.html index 4adb2be..47db381 100755 --- a/manual.en.html +++ b/manual.en.html @@ -35,8 +35,8 @@ needs to be written for every new project.</p> <ul> <li><p>Users and distributions can build and install the software with the -traditional commands "<samp>make</samp>" and -"<samp>make install</samp>".</p></li> +traditional commands “<samp>make</samp>” and +“<samp>make install</samp>”.</p></li> <li><p>All aspects of the build are fully configurable through directory variables, program-name variables and options variables. These configuration @@ -133,7 +133,7 @@ modified is included with the above copyright notice.</p> <a href="INSTALL"><var>INSTALL</var></a> to your source tree.</p></li> <li><p>Write a GNAT project file to control the build. Import -"<samp>comfignat.gpr</samp>" (without "<samp>.gp</samp>") and use the variables +“<samp>comfignat.gpr</samp>” (without “<samp>.gp</samp>”) and use the variables that the project <var>Comfignat</var> defines.</p> <ul> <li><p>Use <var>Comfignat.Objdir</var> for <var>Object_Dir</var>.</p></li> @@ -154,8 +154,8 @@ that the project <var>Comfignat</var> defines.</p> <li><p>If your project is a library, then write a project file for other projects to import to use the library. Give it a filename that ends with -"<samp>.gpr.gp</samp>". It will be run through Gnatprep to generate the actual -project file without the "<samp>.gp</samp>" suffix. Make it import the project +“<samp>.gpr.gp</samp>”. It will be run through Gnatprep to generate the actual +project file without the “<samp>.gp</samp>” suffix. Make it import the project file that the preprocessor symbol <var>Directories_GPR</var> specifies, but only if <var>Directories_GPR</var> is defined. Do not import <var>comfignat.gpr</var>. Use the symbol <var>Includedir</var> in the value of @@ -229,9 +229,9 @@ write them there.</p> <p>Comfignat defines several directory variables to allow distributions and installing users to control where in the filesystem different kinds of files get installed and where applications write their files at run time. Variables -whose names begin with "<var>stage_</var>" point to the directories under the +whose names begin with “<var>stage_</var>” point to the directories under the staging directory where the files shall be written during the build. Variables -without the "<var>stage_</var>" prefix tell where the files will be in the +without the “<var>stage_</var>” prefix tell where the files will be in the target system after installation, and are suitable for embedding in programs where the directory names are needed at run time, and in usage project files.</p> @@ -240,7 +240,7 @@ files.</p> include <var>comfignat.mk</var>, as GNAT project variables to build project files that import <var>comfignat.gpr</var>, and as preprocessor symbols to usage project files that are preprocessed with Gnatprep. If the Make variable -<var>relocatable_package</var> is set to "<samp>true</samp>" on the command +<var>relocatable_package</var> is set to “<samp>true</samp>” on the command line, then the variables for embedding will be relative to <var>bindir</var> in build project files, and relative to <var>gprdir</var> in usage project files, except that <var>bindir</var> will instead be relative to @@ -419,7 +419,7 @@ and the right library will be used in every build.</p> <p>Your software may have optional features or properties that can be enabled or disabled at build time. Comfignat can help you define options for those. Each option is represented as a Make variable whose value can be -"<samp>true</samp>" or "<samp>false</samp>", which installing users and +“<samp>true</samp>” or “<samp>false</samp>”, which installing users and distributions are expected to override on the command line. The names of these variables should be listed in the variable <var>options</var>. Each option should also be assigned a default value, unless it shall be mandatory to always @@ -440,12 +440,12 @@ files.</p> <p>There are several options variables that let installing users and distributions control which arguments the build tools are invoked with. They -have names that end with "<var>FLAGS</var>", and are documented in +have names that end with “<var>FLAGS</var>”, and are documented in <var>INSTALL</var>. The value of <var>GNATFLAGS</var> is a combination of the other options variables and must not be modified in a way that disregards the other variables. Apart from that restriction you can assign default values to optional arguments in these variables, but be sure to do the assignments with -"<samp>?=</samp>" so that environment variables can override your defaults.</p> +“<samp>?=</samp>” so that environment variables can override your defaults.</p> <p>The value of <var>Gnatprep_arguments</var> will be passed to Gnatprep when a file is preprocessed, and <var>builder_arguments</var> will be passed to @@ -458,15 +458,15 @@ options variables instead.</p> <p>The program-name variables <var>GNATPREP</var> and <var>GNAT_BUILDER</var> allow installing users and distributions to control the commands that invoke the build tools, for example to use a specific version or a wrapper. You can -set <var>GNAT_BUILDER</var> to "<samp>gnatmake</samp>" if you want to build +set <var>GNAT_BUILDER</var> to “<samp>gnatmake</samp>” if you want to build with Gnatmake instead of GPRbuild by default, but again be sure to do the -assignment with "<samp>?=</samp>" so that environment variables can override +assignment with “<samp>?=</samp>” so that environment variables can override your default.</p> <h3 id="configuration">Persistent Configuration</h3> <p>Those Make variables that installing users are expected to change can be -configured persistently. Run "<samp>make configure</samp>" with some variables +configured persistently. Run “<samp>make configure</samp>” with some variables set on the command line or in the environment. Those variables will then be saved in a file named <var>comfignat_configuration.mk</var>, which will be loaded in all subsequent Make invocations. Additional variables can be @@ -476,15 +476,15 @@ that can only be overridden on the command line can only be configured from the command line. In subsequent Make invocations environment variables override values that were configured from the environment, and variables set on the command line override all configured values. The configuration can be -erased with "<samp>make unconfigure</samp>" or as a part of -"<samp>make distclean</samp>".</p> +erased with “<samp>make unconfigure</samp>” or as a part of +“<samp>make distclean</samp>”.</p> -<p>The command "<samp>make show_configuration</samp>" may be used to view the +<p>The command “<samp>make show_configuration</samp>” may be used to view the current configuration. It outputs the configured variables in Make assignment syntax, but easier to read than the actual configuration file. Variables that were configured from the command line are shown as ordinary assignments with -"<samp>=</samp>", and those that were configured from the environment are shown -as conditional assignments with "<samp>?=</samp>".</p> +“<samp>=</samp>”, and those that were configured from the environment are shown +as conditional assignments with “<samp>?=</samp>”.</p> <p>The variables that can be configured are listed in the variable <var>configuration_variables</var>. The variables listed in <var>options</var> @@ -497,7 +497,7 @@ names to <var>configuration_variables</var>.</p> directory. All generated files will then be written under the build directory and the source tree will not be modified. You can have several build directories with different configuration files in them. To set up a new build -directory, run "<samp>make configure builddir=/some/pathname</samp>". The +directory, run “<samp>make configure builddir=/some/pathname</samp>”. The variable <var>builddir</var> will not be saved in the configuration; instead a configuration file will be written in the specified directory. A makefile will also be written in the build directory unless there is one already. This |