summaryrefslogtreecommitdiff
path: root/profiles/README
blob: 41269849c9baff6e059b0c67e03470d60d0ad999 (plain)
  1. Class and node definitions
  2. ==========================
  3. Classes and nodes are YAML files parsed by reclass.
  4. Classes
  5. -------
  6. Lowercase classes are reusable, (relatively) objective core classes.
  7. Never include documentation, and avoid pkg-auto or pkg-avoid items.
  8. Capital classes (first letter uppercase) and their subclasses are
  9. subjective high-level bundles. Always include documentation.
  10. Nodes
  11. -----
  12. Nodes should only use capital classes, to have all actions documented.
  13. Parameters
  14. ----------
  15. doc: Documentation
  16. doc-headline: Headline for a group of classes
  17. doc-pkg: Description of purpose of pkg lists in this class
  18. doc-tweak: Description of purpose of tweak in this class
  19. pkg: Packages to install
  20. pkg-auto: Packages to mark auto-installed if installed
  21. pkg-avoid: Packages to remove
  22. tweak: Tweaks to apply after package actions
  23. Tweaks
  24. ------
  25. Tweaks are code snippets executed by a POSIX shell.
  26. Avoid ${...} (reclass use it for parameter interpolation), e.g. by
  27. adding dummy quotes like this: "dpkg-query -Wf='$''{Depends}\n' foo".
  28. Write tweaks for use with debian-installer, using either of below which
  29. will be stripped when generating script target:
  30. * "chroot /target "
  31. * "/target/"