Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openbmc-tools / 9723789d08fce61123c56a67208f5bd5fc7ae807
commit9723789d08fce61123c56a67208f5bd5fc7ae807[log] [tgz]
authorAndrew Jeffery <andrew@aj.id.au>Thu Sep 17 13:08:00 2020 +0930
committerAndrew Jeffery <andrew@aj.id.au>Thu Oct 01 10:20:51 2020 +0930
tree354ffcc63d4b332e39da601afff190ea5f88abaf
parent2cec86428a1cc906aafa759ce730c0bd0bca3fb4 [diff]
README: Clean it up after the reorganisation

* Get rid of the catalogue as all scripts are now in the top level
* Ask for SPDX markers in the license section
* Fix grammar in some areas

Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
Change-Id: Id9b756a507da31b74b5e08bec263a00ff6df2f3a
1 file changed
tree: 354ffcc63d4b332e39da601afff190ea5f88abaf
  1. adcapp/
  2. altitude/
  3. autojson/
  4. bi2cp/
  5. cla-signers/
  6. dbus-pcap/
  7. dbusView/
  8. ddconvnotrunc/
  9. expectedJsonChecker/
  10. format-yaml/
  11. maintainers/
  12. netboot/
  13. openbmc-autobump/
  14. openbmc-events/
  15. openbmctool/
  16. pretty-journal/
  17. pwmtachtool/
  18. reboot/
  19. reboot-ping-pong/
  20. rootfs_size/
  21. sensor_yaml_config/
  22. tracing/
  23. upload_and_update/
  24. witherspoon-debug/
  25. LICENSE
  26. MAINTAINERS
  27. README.md
README.md

The OpenBMC Tools Collection

The goal of this repository is to collect the two-minute hacks you write to automate interactions with OpenBMC systems.

It's highly likely the scripts don't meet your needs - they could be undocumented, dysfunctional or utterly broken. Please help us improve!

Repository Rules

  • Always inspect what you will be executing
  • Some hacking on your part is to be expected

If you're still with us

Then this repository aims to be the default destination for your otherwise un-homed scripts. As such we are setting the bar for submission pretty low, and we aim to make the process as easy as possible.

Sending patches

Please use gerrit for all patches to this repository:

Do note that you will need to be party to the OpenBMC CLA before your contributions can be accepted. See Gerrit Setup and CLA for more information.

What we will do once we have your patches

So long as your patches look sane with a cursory glance you can expect them to be applied. We may push back in the event that similar tools already exist or there are egregious issues.

What you must have in your patches

We don't ask for much, but you need to give us at least a Signed-off-by, use SPDX markers in your source files and put your work under an Apache 2.0 compatible license.

How you consume the repository

There's no standard way to install the scripts housed here, and adding parts of the repository to your PATH might be a bit of a dice-roll. We may also move or remove scripts from time to time as part of housekeeping. It's probably best to copy things out if you need stability.