Skip to content

Commit 4336020

Browse files
committed
Update documentation
1 parent d82ce30 commit 4336020

File tree

3 files changed

+11
-13
lines changed

3 files changed

+11
-13
lines changed

fpm/src/fpm_backend.f90

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
!># Build backend
2-
!> Uses a valid `[[fpm_model]]` instance to schedule and execute the
3-
!> compilation and linking of package targets.
2+
!> Uses a list of `[[build_target_ptr]]` and a valid `[[fpm_model]]` instance
3+
!> to schedule and execute the compilation and linking of package targets.
44
!>
55
!> The package build process (`[[build_package]]`) comprises three steps:
66
!>

fpm/src/fpm_model.f90

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,11 @@
33
!> Defines the fpm model data types which encapsulate all information
44
!> required to correctly build a package and its dependencies.
55
!>
6-
!> The process (see `[[build_model(subroutine)]]`) for generating a valid `[[fpm_model]]` is as follows:
6+
!> The process (see `[[build_model(subroutine)]]`) for generating a valid `[[fpm_model]]` involves
7+
!> source files discovery ([[fpm_sources]]) and parsing ([[fpm_source_parsing]]).
78
!>
8-
!> 1. Source files are discovered ([[fpm_sources]]) and parsed ([[fpm_source_parsing]])
9-
!> 2. A list of build targets is generated (`[[targets_from_sources]]`) from the sources
10-
!> 3. Inter-target dependencies are resolved (`[[resolve_module_dependencies]]`) based on modules used and provided
11-
!> 4. Object link lists are generated for link targets (executables and libraries) (`[[resolve_target_linking]]`)
12-
!>
13-
!> Once a valid `[[fpm_model]]` has been constructed, it may be passed to `[[fpm_backend:build_package]]` to
14-
!> build the package.
9+
!> Once a valid `[[fpm_model]]` has been constructed, it may be passed to `[[fpm_targets:targets_from_sources]]` to
10+
!> generate a list of build targets for the backend.
1511
!>
1612
!>### Enumerations
1713
!>
@@ -21,9 +17,6 @@
2117
!> __Source scope:__ `FPM_SCOPE_*`
2218
!> Describes the scoping rules for using modules — controls module dependency resolution
2319
!>
24-
!> __Target type:__ `FPM_TARGET_*`
25-
!> Describes the type of build target — determines backend build rules
26-
!>
2720
module fpm_model
2821
use iso_fortran_env, only: int64
2922
use fpm_strings, only: string_t, str

fpm/src/fpm_targets.f90

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@
1818
!> - `[[build_target_list]]`
1919
!> - `[[resolve_module_dependencies]]`
2020
!>
21+
!>### Enumerations
22+
!>
23+
!> __Target type:__ `FPM_TARGET_*`
24+
!> Describes the type of build target — determines backend build rules
25+
!>
2126
module fpm_targets
2227
use iso_fortran_env, only: int64
2328
use fpm_error, only: error_t, fatal_error

0 commit comments

Comments
 (0)