Skip to content

Commit 6c9518b

Browse files
authored
Improve documentation of VCS scripts
Some of the documentation was based on an old version of the code.
1 parent 43069e7 commit 6c9518b

2 files changed

Lines changed: 3 additions & 6 deletions

File tree

generate_vcs_identifier.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
identifier string. It retrieves the VCS identifier from the 'vcs_utils' module
66
and writes it to a specified source file.
77
8-
The script will overwrite the file if it already exists, and any write failures
9-
are handled gracefully.
10-
118
This script should be loaded by PlatformIO during the project build and is not
129
designed to be run independently.
1310
"""

vcs_utils.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
vcs_utils.py
33
44
This module provides utility functions to retrieve the version control system
5-
(VCS) identifier using Git and to write it to a C source file.
5+
(VCS) identifier using Git and to write it to a file.
66
77
The functions handle cases where Git is not installed or the current directory
88
is not a Git repository, and handle file write failures gracefully.
@@ -43,11 +43,11 @@ def get_vcs_id():
4343

4444
def write_vcs_id_to_file(vcs_id, file_path):
4545
"""
46-
Writes the given VCS identifier as a C-style string to a file.
46+
Defines a macro with the given VCS identifier as a string literal to a file.
4747
4848
Args:
4949
vcs_id (str): The VCS identifier string to write to the file.
50-
file_path (str): The path to the C source file to write to.
50+
file_path (str): The path to the file to write to.
5151
5252
If the file exists, it will be overwritten. If writing to the file fails,
5353
a warning will be printed to stderr, but the script will not terminate

0 commit comments

Comments
 (0)