Skip to content

lib: Rename README files in lib to fit the GitHub visualization. #250

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jan 9, 2025
Merged

lib: Rename README files in lib to fit the GitHub visualization. #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a833231
lib: Rename README files to README.rst
benothmn-st Dec 27, 2024
7687cea
scripts: Rename README files in the ble_library script
benothmn-st Dec 27, 2024
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
0 lib/README → lib/README.rst
View file
Open in desktop
File renamed without changes.
0 lib/stm32wb/README → lib/stm32wb/README.rst
View file
Open in desktop
File renamed without changes.
0 lib/stm32wb0/README → lib/stm32wb0/README.rst
View file
Open in desktop
File renamed without changes.
0 lib/stm32wba/README → lib/stm32wba/README.rst
View file
Open in desktop
File renamed without changes.
12 changes: 6 additions & 6 deletions scripts/ble_library.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,22 +194,22 @@ def copy_ble_lib_files(src_repo_path, dest_lib_path, stm32_serie):


def update_ble_lib_readme(lib_path, make_version, make_commit):
"""Update README file
"""Update README.rst file

Args:
dest_lib_path: library path
make_version: latest STM32Cube version.
make_commit: Commit corresponding to latest STM32Cube version.
"""

readme_path = Path(lib_path / "README")
readme_path = Path(lib_path / "README.rst")

with readme_path.open(mode="r") as readme_prev:
lines = (x for x in readme_prev.read().splitlines())

readme_path.unlink()

# Write README from previous one if exists
# Write README.rst from previous one if exists
with open(str(readme_path), "w") as readme_file:
for line_item in lines:
# change version nb
Expand Down Expand Up @@ -285,8 +285,8 @@ def build_patch_from_current_zephyr_version(
for file in temp_source_lib_path.glob("*"):
if file.is_file():
file.unlink()
if Path(temp_source_lib_path / "README").exists():
Path(temp_source_lib_path / "README").unlink()
if Path(temp_source_lib_path / "README.rst").exists():
Path(temp_source_lib_path / "README.rst").unlink()

# commit this current zephyr library file
os_cmd(("git", "add", "*"), cwd=temp_source_path)
Expand Down Expand Up @@ -337,7 +337,7 @@ def update(
)
copy_ble_lib_files(src_repo_path, dest_lib_path, stm32_serie)
common_utils.apply_patch(dest_lib_path / "ble_zephyr.patch", dest_lib_path)
if Path(dest_lib_path / "README").exists():
if Path(dest_lib_path / "README.rst").exists():
update_ble_lib_readme(dest_lib_path, update_version, commit)


Expand Down
Loading