Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / docs / 3b90d1ee57ee5c3b39f595113ed419f18b017c97
commit3b90d1ee57ee5c3b39f595113ed419f18b017c97[log] [tgz]
authorJanet Adkins <janeta@us.ibm.com>Thu Dec 12 16:22:46 2024 -0600
committerJanet Adkins <janeta@us.ibm.com>Mon Jan 06 14:44:49 2025 -0600
tree990d1c931470e36f58b54a232edb2c33a5391b18
parent35c2005ffe02fc240dfcd77ad9658fd66dcee524 [diff]
object-mapper: Clarify GetSubTree interfaces param

The existing documentation on the optional <interfaces> parameter to the
GetSubTree handler and other related handlers is not clear. The wording
implies that the only interfaces returned in the dictionary will be the
ones specified by the <interfaces> parameter.

The examples show that is not the behavior.
The implementation of getSubTree() confirms this behavior. [1]

I've reworded like GetObject handler to clarify.

[1] https://github.com/openbmc/phosphor-objmgr/blob/d01fca35bf709c179ba5ade01b127b2a31ebfbce/src/handler.cpp#L139

Change-Id: Icdf407d677e8ba4c235bb10aad67d90e096ac88e
Signed-off-by: Janet Adkins <janeta@us.ibm.com>
1 file changed
tree: 990d1c931470e36f58b54a232edb2c33a5391b18
  1. architecture/
  2. designs/
  3. development/
  4. logo/
  5. process/
  6. release/
  7. security/
  8. style/
  9. testing/
  10. tof/
  11. userguide/
  12. .markdownlint.yaml
  13. .prettierrc.yaml
  14. anti-patterns.md
  15. cheatsheet.md
  16. code-of-conduct.md
  17. community-membership.md
  18. console.md
  19. CONTRIBUTING.md
  20. cpp-style-and-conventions.md
  21. discord-rules.md
  22. features.md
  23. glossary.md
  24. host-management.md
  25. hw-vendor-repos-policy.md
  26. IPMITOOL-cheatsheet.md
  27. kernel-development.md
  28. LICENSE
  29. maintainer-workflow.md
  30. Makefile
  31. meta-layer-guidelines.md
  32. openbmc-conversion.md
  33. OWNERS
  34. README.md
  35. REDFISH-cheatsheet.md
  36. rest-api.md
  37. REST-cheatsheet.md
  38. SECURITY.md
  39. subtree.md
  40. yocto-development.md
README.md

OpenBMC documentation

The OpenBMC project is a Linux Foundation project whose goal is to produce a customizable, open-source firmware stack for Baseboard Management Controllers (BMCs). This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.

The features document lists the project's major features with links to more information.

Contact

OpenBMC Development

These documents contain details on developing OpenBMC code itself

OpenBMC Usage

These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.