Skip to content

examples: shorten subfolders' names#21221

Merged
OlegHahm merged 1 commit intoRIOT-OS:masterfrom
mguetschow:examples-names-short
Feb 21, 2025
Merged

examples: shorten subfolders' names#21221
OlegHahm merged 1 commit intoRIOT-OS:masterfrom
mguetschow:examples-names-short

Conversation

@mguetschow
Copy link
Copy Markdown
Contributor

@mguetschow mguetschow commented Feb 17, 2025 •
edited
Loading

Contribution description

Shorten some subfolder names in the examples directory to make them less verbous:

  • examples/essentials => examples/basic
  • examples/advanced_examples/ => examples/advanced
  • examples/networking/bluetooth_low_energy/misc_ble_examples => examples/networking/ble/misc
  • examples/networking/gnrc_networking => examples/networking/gnrc
  • examples/networking/core_resource_directory => examples/networking/cord
  • examples/language_bindings/{officially,community}_supported => examples/lang_support/{official,community}

I'm not particularly happy with language_bindings as name either, but could not come up with a shorter one. Maybe language_support would be better although not much shorter?

Testing procedure

Check if CI still builds all examples, check working links in examples/README.md

Issues/PRs references

Follow-up of #21135 by @AnnsAnns

@github-actions github-actions bot added Area: doc Area: Documentation Area: tests Area: tests and testing framework Area: build system Area: Build system Area: pkg Area: External package ports Area: drivers Area: Device drivers Area: BLE Area: Bluetooth Low Energy support Area: CI Area: Continuous Integration of RIOT components Area: tools Area: Supplementary tools Area: boards Area: Board ports Platform: ESP Platform: This PR/issue effects ESP-based platforms Area: cpu Area: CPU/MCU ports Area: sys Area: System Area: examples Area: Example Applications Area: Kconfig Area: Kconfig integration labels Feb 17, 2025
@mguetschow mguetschow added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Feb 17, 2025
@riot-ci
Copy link
Copy Markdown

riot-ci commented Feb 17, 2025 •
edited
Loading

Murdock results

✔️ PASSED

9a45c30 examples: shorten subfolders' names

Success Failures Total Runtime
10271 0 10271 09m:32s

Artifacts

@AnnsAnns
Copy link
Copy Markdown
Member

AnnsAnns commented Feb 17, 2025

I like this change, with my PR I wanted to stay 1:1 with the category titles but yours sound better as folder names 😄 Thank you for putting so much effort into refining my stuff!

@kaspar030
Copy link
Copy Markdown
Contributor

kaspar030 commented Feb 17, 2025

I'm not particularly happy with language_bindings as name either, but could not come up with a shorter one. Maybe language_support would be better although not much shorter?

Maybe just lang?

@mguetschow
Copy link
Copy Markdown
Contributor Author

mguetschow commented Feb 17, 2025

Maybe just lang?

I tried to have the high-level ones a bit more speaking. But I'm also fine with lang, but would then also propose net instead of networking (and maybe basic instead of essentials). Any other opinions?

OlegHahm
OlegHahm reviewed Feb 17, 2025
View reviewed changes
OlegHahm
OlegHahm reviewed Feb 17, 2025
View reviewed changes
OlegHahm
OlegHahm reviewed Feb 17, 2025
View reviewed changes
OlegHahm
OlegHahm requested changes Feb 17, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@OlegHahm OlegHahm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, for the bunch of unrelated findings. Besides these cosmetics: ACK from my side.

@mguetschow
Copy link
Copy Markdown
Contributor Author

mguetschow commented Feb 18, 2025

@OlegHahm Thanks for having a detailed read-through! Fixed all the typos (borader is a nice one) and squashed directly 😈

@mguetschow mguetschow requested a review from OlegHahm February 18, 2025 09:01
@AnnsAnns AnnsAnns mentioned this pull request Feb 19, 2025
Closed
OlegHahm
OlegHahm reviewed Feb 20, 2025
View reviewed changes
@mguetschow mguetschow mentioned this pull request Feb 20, 2025
Merged
OlegHahm
OlegHahm reviewed Feb 20, 2025
View reviewed changes
OlegHahm
OlegHahm reviewed Feb 20, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@OlegHahm OlegHahm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used or LINE in $(git show | grep '^+' | grep -oE 'examples[^*,)$" ]*'); do ls -lah ${LINE} > /dev/null ; done` to get a quick overview about potentially invalid path names and found one more case of a broken link.

@mguetschow mguetschow requested a review from OlegHahm February 21, 2025 08:56
OlegHahm
OlegHahm approved these changes Feb 21, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@OlegHahm OlegHahm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't spot any issues with the latest state so I dare to give an ACK. 👍

@OlegHahm OlegHahm enabled auto-merge February 21, 2025 09:00
@OlegHahm OlegHahm added this pull request to the merge queue Feb 21, 2025
This was referenced Feb 21, 2025
Merged
Merged
Merged
Merged
Merged
Merged via the queue into RIOT-OS:master with commit 4d41dda Feb 21, 2025
26 checks passed
@mguetschow mguetschow deleted the examples-names-short branch February 21, 2025 11:37
@mguetschow
Copy link
Copy Markdown
Contributor Author

mguetschow commented Feb 21, 2025

Thanks for your thorough review!

@mguetschow mguetschow added this to the Release 2025.04 milestone Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OlegHahm OlegHahm OlegHahm approved these changes

@maribu maribu maribu approved these changes

@leandrolanzieri leandrolanzieri Awaiting requested review from leandrolanzieri leandrolanzieri is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

@MrKevinWeiss MrKevinWeiss Awaiting requested review from MrKevinWeiss MrKevinWeiss is a code owner

@miri64 miri64 Awaiting requested review from miri64 miri64 is a code owner

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@MichelRottleuthner MichelRottleuthner Awaiting requested review from MichelRottleuthner MichelRottleuthner is a code owner

@bergzand bergzand Awaiting requested review from bergzand bergzand is a code owner

@kaspar030 kaspar030 Awaiting requested review from kaspar030 kaspar030 is a code owner

@PeterKietzmann PeterKietzmann Awaiting requested review from PeterKietzmann

@gschorcht gschorcht Awaiting requested review from gschorcht gschorcht is a code owner

@chrysn chrysn Awaiting requested review from chrysn chrysn is a code owner

@dylad dylad Awaiting requested review from dylad dylad is a code owner

Assignees

No one assigned

Labels

Area: BLE Area: Bluetooth Low Energy support Area: boards Area: Board ports Area: build system Area: Build system Area: CI Area: Continuous Integration of RIOT components Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation Area: drivers Area: Device drivers Area: examples Area: Example Applications Area: Kconfig Area: Kconfig integration Area: pkg Area: External package ports Area: sys Area: System Area: tests Area: tests and testing framework Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Platform: ARM Platform: This PR/issue effects ARM-based platforms Platform: ESP Platform: This PR/issue effects ESP-based platforms Platform: native Platform: This PR/issue effects the native platform

Projects

None yet

Milestone

Release 2025.04

Development

Successfully merging this pull request may close these issues.

7 participants

@mguetschow @riot-ci @AnnsAnns @kaspar030 @miri64 @maribu @OlegHahm