Lhogho
0.0.028
|
This section describes how to build new releases of Lhogho sources, how to install a release, how to compile Lhogho and rebuild its documentation.
?.?.???
stands for the full release number (e.g. 0.0.005
)
This section describes the directories that are used to develop and compile Lhogho. The root directory is assumed to be lhogho
and all development directioes are in it.
lhogho/sandbox
When Lhogho is being developed, compiled code + libraries + test programs are copied to this folder, so testing is done inside the sandbox. Note, that sandbox is only for testing during development.
lhogho/sandbox/web/devdoc
Contains the compiled Developer's documentation. This is a set of *
.html and *
.png files. The Developer's documentation is viewed by opening index.html
in a browser.
lhogho/src
Contains all sources of Lhogho - the compiler, the test suite, the documentation.
lhogho/src/doc
Contains all sources of Lhogho documentation.
lhogho/src/doc/dev
Contains all sources of Lhogho developers documentation in Doxygen (*.dox) format. Available makefile options:
Compiles the Developer's documentation into a web site (mostly *
.html and *
.png files). The main file is index.html
. All the files are placed in the Sandbox's folder lhogho/sandbox/doc/dev
.
Removes all files of the compiled Developer's documentation from the Sandbox's folder lhogho/sandbox/doc/dev
.
Shows short help information about the makefile options.
A developer's release is a package containing all Lhogho sources (including the compiler and the documentation). The Developer's release does not include Lhogho binary or the HTML version of the documentation.
To prepare a new release first set the release version in file src/version
. Then from the src
folder execute:
As a result three new files should appear in the folder:
The names of the files start with lhogho
followed by the complete release number - a sequence of X.Y.ZZZ
, where X
is the major version number, Y
is the minor version number and ZZZ
is the build number.
The file lhogho.?.?.???.src.tar.gz
is the Developer's release. It contains compiler and documentation sources needed to recompile Lhogho and regenerate its documentation.
The file lhogho.?.?.???.doc.tar.gz
contains the Developer's Documentation in preprocessed HTML format. It is needed only if the documentation sources cannot be rebuilt with Doxygen. The Developer's Documentation in this package is platform independent.
The file lhogho.?.?.???.bin.tar.gz
contains the binary (executable) of the Lhogho compiler along with one simple test source file. The binary file is strictly platform dependable. It is highly suggested to recompile Lhogho rather than to use a prebuilt binary.
Releases are deployed in the form of GZIPed TARred files. Provided that you have downloaded lhogho.?.?.???.src.tar.gz
in an empty folder and this folder is your current folder, installation completes in this way:
The commands above create a folder src containing all sources of the release. For a large number of operating systems it is possible to directly unpack the *.TAR.GZ file from the user interface.
To compile Lhogho and generate its documentation (you need GCC and DOXYGEN) enter the source directory and execute make:
As a result the executable lhogho.exe
(for Windows/Cygwin) or lhogho
(for Linux) is created in src/core/
and the HTML documentation is generated in doc/
folder.
To compile only Lhogho (you need GCC) enter Lhogho's source directory and rebuild:
As a result the executable lhogho.exe
(for Windows/Cygwin) or lhogho
(for Linux) is created in src/core/
.
To compile only Lhogho documentation (you need DOXYGEN) enter Lhogho's documentation source directory and execute make:
As a result the HTML documentation is generated in doc/
folder.
To clean all files which can be regenerated (Lhogho binary and/or HTML documentation) execute:
from the appropriate directory.
In case it is neede to install preprocessed documentation, download the Developer's Documentation file lhogho.?.?.???.doc.tar.gz
and unpack it similarily to how the Developer's Release is unpacked.
This section describes define symbols in the compiler's source which determine what functionality to include in the compiler. These defines are defined in globals.h file.
Z
options are available only in the ADVANCED
mode.The globals.h file contains a set of define symbols which control what parts of the source code to compile. These defines are used for debugging purposes only. By default most of the defines are switched off. To use any of them remove the prefix no from the name.
To compile only lhogho tester application (you need GCC) enter Lhogho's test directory and rebuild:
As a result the executable lTester.exe
(for Windows/Cygwin) or lTester
(for Linux) is created in src/test/
folder.