Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / openbmc-tools / 6b4b9df44144c1cc2072eb1847a9fb335d326710
commit6b4b9df44144c1cc2072eb1847a9fb335d326710[log] [tgz]
authorEd Tanous <edtanous@google.com>Tue Feb 01 13:12:28 2022 -0800
committerAndrew Jeffery <andrew@aj.id.au>Thu Feb 10 21:08:10 2022 +0000
tree7a3a526030a436fb7554c6bd6640b8e8c220971c
parentd97f2f150cda0e6dce9f50217c84f13e60b82314 [diff]
Allow script to be used without a git alias

The script as it exists today relies on an ssh alias, which leads to
non-obvious error messages if it's not set up.  This is a case where
99% of the time people will be using the defaults, so we should make the
defaults as helpful as we can.

Tested:
Ran the commands in the README and saw that they succeeded.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I754b31ad9dae47af20c7cd8f4bbb4951119d061d
1 file changed
tree: 7a3a526030a436fb7554c6bd6640b8e8c220971c
  1. adcapp/
  2. altitude/
  3. autojson/
  4. bbdbg/
  5. bi2cp/
  6. cla-signers/
  7. dbus-pcap/
  8. dbus-vis/
  9. dbusView/
  10. ddconvnotrunc/
  11. expectedJsonChecker/
  12. format-yaml/
  13. maintainers/
  14. netboot/
  15. openbmc-autobump/
  16. openbmc-events/
  17. openbmctool/
  18. overlay/
  19. pldm/
  20. prepare-emmc-qemu/
  21. pretty-journal/
  22. pwmtachtool/
  23. reboot/
  24. reboot-ping-pong/
  25. rootfs_size/
  26. sensor_yaml_config/
  27. tof-voters/
  28. tracing/
  29. upload_and_update/
  30. witherspoon-debug/
  31. LICENSE
  32. MAINTAINERS
  33. 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.