Skip to content
This repository has been archived by the owner on Nov 9, 2017. It is now read-only.

Commit

Permalink
update documentation/manpage for stackable entity definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
majewsky committed Sep 26, 2015
1 parent bb06114 commit 6dfeed3
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/manpage.pod
Original file line number Diff line number Diff line change
Expand Up @@ -334,6 +334,20 @@ be files belonging to the users/groups in question. Recommended best practice
is to have the hologram print a message in its post-remove routine instructing
the administrator to clean up lingering users/groups manually.

Like for configuration files, multiple holograms can contribute to a single
entity. But when multiple definitions for one entity are stacked on top of
each other, they are not allowed to contradict itself. For example, if two
holograms define different home directories, this will be considered an error,
since both holograms might rely on their respective home directory settings.

$ cat /usr/share/holo/01-first.json
{ "users: [ { "name": "foo", "home": "/home/foo" } ] }
$ cat /usr/share/holo/02-second.json
{ "users: [ { "name": "foo", "home": "/var/lib/foo" } ] }
$ holo scan
[holo] Failed to read /usr/share/holo/02-second.json:
[holo] conflicting home directory for user 'foo' (existing: /home/foo, new: /var/lib/foo)

=head1 AUTHOR

Stefan Majewsky
Expand Down
14 changes: 14 additions & 0 deletions doc/website-doc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -309,4 +309,18 @@ be files belonging to the users/groups in question. Recommended best practice
is to have the hologram print a message in its post-remove routine instructing
the administrator to clean up lingering users/groups manually.

Like for configuration files, multiple holograms can contribute to a single
entity. But when multiple definitions for one entity are stacked on top of
each other, they are not allowed to contradict itself. For example, if two
holograms define different home directories, this will be considered an error,
since both holograms might rely on their respective home directory settings.

$ cat /usr/share/holo/01-first.json
{ "users: [ { "name": "foo", "home": "/home/foo" } ] }
$ cat /usr/share/holo/02-second.json
{ "users: [ { "name": "foo", "home": "/var/lib/foo" } ] }
$ holo scan
[holo] Failed to read /usr/share/holo/02-second.json:
[holo] conflicting home directory for user 'foo' (existing: /home/foo, new: /var/lib/foo)

=cut

0 comments on commit 6dfeed3

Please sign in to comment.