aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2024-10-01 10:52:20 +0200
committerThomas White <taw@physics.org>2024-10-01 10:52:20 +0200
commit8ef5a9b6de216a4117244771c177570d2f67534c (patch)
tree6947f8fe7b1691e0108d77c68373393692c255f2 /doc
parenta2ba535836d1514b9fdf0ee9bf06bb1cea5f70a4 (diff)
Update documentation about group directives in geometry files
Diffstat (limited to 'doc')
-rw-r--r--doc/man/crystfel_geometry.5.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/man/crystfel_geometry.5.md b/doc/man/crystfel_geometry.5.md
index 640771ee..4328ebc0 100644
--- a/doc/man/crystfel_geometry.5.md
+++ b/doc/man/crystfel_geometry.5.md
@@ -535,9 +535,15 @@ above.
The highest-level group should always be called **all**.
All members of a group need to be defined before defining the group. This
-means that the group definitions must come **after** the panel definitions, and
-the groups should be defined from the bottom to top level of the hierarchy -
-the **all** group coming last.
+means that the group definitions shuld come **after** the panel definitions,
+and the groups should be defined from the bottom to top level of the hierarchy
+with the **all** group coming last. As a convenience, CrystFEL 0.11.1 and
+later defer processing **group** lines until the rest of the geometry file
+has been read. That means that you can put your **group** lines near the top
+of the file, but the groups must still be defined from bottom to top level.
+To maintain compatability with CrystFEL 0.11.0, tools that write geometry
+files (e.g. **align_detector**) from later CrystFEL versions will put the group
+directives at the end of the file.
If you do not define any groups, CrystFEL will automatically create the **all**
group for you, containing all panels in a flat hierarchy. This allows basic