Skip to content

Commit f392275

Browse files
committed
docs: cosmetic changes
Signed-off-by: AtomicFS <vojtech.vesely@9elements.com>
1 parent b2fd805 commit f392275

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

docs/src/firmware-action/change_detection.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Change detection
22

3-
firmware-action has basic detection of changes.
3+
`firmware-action` has basic detection of changes.
44

55
Related temporary files to aid in change detection are stored in `.firmware-action/` directory, which is always created in current working directory.
66

77
```admonish note
88
It is save to delete the `.firmware-action/` directory, but keep in mind that change detection depends on its existence.
99
10-
If `.firmware-action/` directory is deleted, it will be re-created on next firmware-action execution.
10+
If `.firmware-action/` directory is deleted, it will be re-created on next `firmware-action` execution.
1111
1212
It might be advantageous to also include this directory in caches / artifacts when in CI. Preserving these files might reduce run time in the CI.
1313
```
1414

1515

1616
## Sources modification time
1717

18-
When building a module, firmware-action checks recursively all sources for a given module. For all module types, list of sources include repository and all input files.
18+
When building a module, `firmware-action` checks recursively all sources for a given module. For all module types, list of sources include repository and all input files.
1919

2020
```admonish example collapsible=true title="Code snippet: Common sources"
2121
~~~golang
@@ -37,9 +37,13 @@ On next run, this file (if exists) is loaded with time stamp of last successful
3737

3838
## Configuration file changes
3939

40-
Firmware-action can also detect changes in the configuration file. For each module, on each successful build, it stores a copy of the configuration in `.firmware-action/configs/` directory. On next run, current configuration is compared to configuration of last successful build, and if the configuration for the specific module differs, module is re-built.
40+
`firmware-action` can also detect changes in the configuration file. For each module, on each successful build, it stores a copy of the configuration in `.firmware-action/configs/` directory.
41+
42+
On next run, current configuration is compared to configuration of last successful build, and if the configuration for the specific module differs, module is re-built.
4143

4244

4345
## Git commit hash changes
4446

45-
`firmware-action` can detect changes based on git commit hashes. For each module, on each successful build, it stores the git commit hash of the module's repository path (`repo_path`) in `.firmware-action/git-hash/` directory. On next run, the current git commit hash of the module's repository is compared to the stored hash from the last successful build. If the hashes differ, indicating that the module's repository has been changed, the module is re-built.
47+
`firmware-action` can detect changes based on git commit hashes. For each module, on each successful build, it stores the git commit hash of the module's repository path (`repo_path`) in `.firmware-action/git-hash/` directory.
48+
49+
On next run, the current git commit hash of the module's repository is compared to the stored hash from the last successful build. If the hashes differ, indicating that the module's repository has been changed, the module is re-built.

0 commit comments

Comments
 (0)