Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor documentation update for #277. #284

Merged
merged 2 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/source/advanced_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,22 @@ import your grab configuration to find out where it put the source.

if __name__ == '__main__':
with BuildConfig(project_label='<project_label>') as state:
grab_folder(state, src=grab_config.source_root),
grab_folder(state, src=my_grab_config.source_root),


Housekeeping
============

Fab will remove old files from the prebuilds folder. It will remove all prebuild files that are not part of the current build by default.
You can add a :func:`~fab.steps.cleanup_prebuilds.cleanup_prebuilds`
step, where you can explicitly control how long to keep prebuild files.
This may be useful, for example, if you often switch between two versions
of your code and want to keep the prebuild speed benefits when building
both.

If you add a :func:`~fab.steps.cleanup_prebuilds.cleanup_prebuilds` step, you
can keep prebuild files for longer. This may be useful, for example, if you
often switch between two versions of your code and want to keep the prebuild
speed benefits when building both.
If you do not add your own cleanup_prebuild step, Fab will
automatically run a default step which will remove old files from the
prebuilds folder. It will remove all prebuild files that are not part of
the current build by default.


Sharing Prebuilds
Expand Down
4 changes: 2 additions & 2 deletions docs/source/environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
Environment
***********

Fab requires a suitible Python environment in which to run. This page outlines
Fab requires a suitable Python environment in which to run. This page outlines
some routes to achieving such an environment.

This page contains general instructions, there are additional instructions for
:ref:`Met Office<MetOffice>` users elsewhere.
:ref:`Met Office<MetOfficeUsage>` users elsewhere.


.. _Requirements:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/writing_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -236,14 +236,14 @@ However preprocessing C currently requires a preceding step called the
into the C code so Fab is able to deduce which inclusions are user code and
which are system code. This allows system dependencies to be ignored.

See also :ref:`Advanced C Code<Advanced C Code>`
See also :ref:`Advanced C Code<C Pragma Injector>`


Further Reading
===============

More advanced configuration topics are discussed in
:ref:`Advanced Configuration`.
:ref:`Advanced Config`.

You can see more complicated configurations in the
`developer testing directory <https://github.com/metomi/fab/tree/master/run_configs>`_.
2 changes: 1 addition & 1 deletion source/fab/steps/compile_fortran.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def compile_fortran(config: BuildConfig, common_flags: Optional[List[str]] = Non
A list of :class:`~fab.build_config.AddFlags`, defining flags to be included in the command line call
for selected files.
:param source:
An :class:`~fab.artefacts.ArtefactsGetter` which give us our c files to process.
An :class:`~fab.artefacts.ArtefactsGetter` which gives us our Fortran files to process.

"""

Expand Down
Loading