Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
argo
aml
Commits
59070b5e
Commit
59070b5e
authored
Dec 09, 2020
by
Swann Perarnau
Browse files
Merge branch 'tutorial-doc-cleanup' into 'staging'
Small doc cleanup See merge request
!134
parents
1b8d5db5
b1190e07
Pipeline
#12128
passed with stages
in 6 minutes and 53 seconds
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
doc/index.rst
View file @
59070b5e
...
...
@@ -52,7 +52,7 @@ Download
.. code-block:: console
$ git clone --recurse-submodules
git@
xgitlab.cels.anl.gov
:
argo/aml.git
$ git clone --recurse-submodules
https://
xgitlab.cels.anl.gov
/
argo/aml.git
Requirements:
~~~~~~~~~~~~~
...
...
@@ -61,6 +61,7 @@ Requirements:
* automake
* libtool
* libnuma
* hwloc (>2.1)
Installation
~~~~~~~~~~~~
...
...
@@ -92,7 +93,7 @@ Check the AML version:
return 1;
}
Initialize and clean up the
AML
:
Initialize and clean up the
library
:
.. code-block:: c
...
...
doc/tutorials/getting_started.rst
View file @
59070b5e
...
...
@@ -10,7 +10,7 @@ Download
.. code-block:: console
$ git clone
git@
xgitlab.cels.anl.gov
:
argo/aml.git
$ git clone
--recurse-submodules https://
xgitlab.cels.anl.gov
/
argo/aml.git
$ git checkout staging
Requirements:
...
...
doc/tutorials/hello_world/hello_world.rst
View file @
59070b5e
...
...
@@ -19,7 +19,30 @@ Setup/Teardown API
Version API
~~~~~~~~~~~
.. doxygengroup:: aml_version
AML defines its version using semantic versioning, with a macro and variable
for each subcomponent of the version number:
- **Version major**: denotes ABI changes which prevent compatibility with previous
major version ABI.
- **Version minor**: denotes new features or improvement without breaking the old
ABI.
- **Patch version**: patch and fix releases only.
The full version string is also available directly.
.. code-block:: c
/* see aml/utils/version.h for details */
#define AML_VERSION_MAJOR ...
#define AML_VERSION_MINOR ...
#define AML_VERSION_PATCH ...
#define AML_VERSION_STRING ...
extern const int aml_version_major = ...;
extern const int aml_version_minor = ...;
extern const int aml_version_patch = ...;
extern const char *aml_version_string = ...;
Usage
-----
...
...
@@ -34,7 +57,6 @@ header.
Initialization is done by passing pointers to the command-line arguments of
the program to the library.
.. code-block:: c
int main(int argc, char **argv){
...
...
@@ -44,7 +66,8 @@ the program to the library.
return 1;
}
Checking the version is as easy as comparing the header version
Checking that the program is linked against the same version as the one used
during compilation is as easy as comparing the header version
*AML_VERSION_MAJOR* and the library-embedded version *aml_version_major*.
.. code-block:: c
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment