Skip to content
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.

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

examples: shorten subfolders' names #21221

Merged
merged 1 commit into from
Feb 21, 2025

Conversation

mguetschow
Copy link
Contributor

@mguetschow mguetschow commented Feb 17, 2025

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

riot-ci commented Feb 17, 2025

Murdock results

✔️ PASSED

9a45c30 examples: shorten subfolders' names

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

Artifacts

@AnnsAnns
Copy link
Contributor

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
Contributor

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
Contributor Author

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?

Copy link
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
Contributor Author

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

Copy link
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.

Copy link
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. 👍

@mguetschow
Copy link
Contributor Author

Thanks for your thorough review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

7 participants