Skip to content

Commit

Permalink
Document the partial linking settings
Browse files Browse the repository at this point in the history
Closes #20
  • Loading branch information
AngheloAlf committed Apr 27, 2024
1 parent bdcea9f commit 34ae562
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/file_format/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,55 @@ Boolean.

## `partial_scripts_folder`

This setting is used when generating partial linker scripts for incremental
linking, thus being ignored during normal linker script generation.

This field holds a path to a folder where the generated partial linker scripts
will be written to.

Each partial script will be named like the segment's name with a `.ld` file
extension. If dependency generation is enabled then dependency files will be
generated in this folder for each partial linker script, named like the
segment's name and `.d` as the file extension.

### Example

```yaml
settings:
partial_scripts_folder: linker_scripts/partial/
```

### Valid values

Non-empty path.

## `partial_build_segments_folder`

This setting is used when generating partial linker scripts for incremental
linking, thus being ignored during normal linker script generation.

This field holds a path to a folder where each built partial segment will be
placed by the build system in use. Each built partial segment is expected to be
named after the corresponding segment and use a `.o` file extension.

This path will be prefixed by the [`base_path`](#base_path) field during
generation the scripts generation.

### Example

```yaml
settings:
base_path: build/us
partial_scripts_folder: segments/
```

The above example indicates the built partial segments will be in the
`build/us/segments/`

### Valid values

Non-empty path.

## `alloc_sections`

List of allocatable sections (the ones that take ROM space).
Expand Down

0 comments on commit 34ae562

Please sign in to comment.