summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorancient-skyscraper <bwb+dcpomaticcom@gibibyte.com>2023-03-09 14:16:56 -0500
committerCarl Hetherington <cth@carlh.net>2023-03-10 21:57:57 +0100
commitb4ab9f4adc9dd10d0f1a33286d78821da580a4d1 (patch)
treee4c57b72dd40377f448afc2991a7d4a9db9f9271 /doc
parent988e8d923fa30bca1be6ec78455324e1f2e62771 (diff)
Update documentation and CLI UI with hint info
Goal is to explain what hints are, and how the `--hints` option changes behavior of `dcpomatic2_cli` command
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/dcpomatic.xml15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/manual/dcpomatic.xml b/doc/manual/dcpomatic.xml
index dd59facfa..81321a83d 100644
--- a/doc/manual/dcpomatic.xml
+++ b/doc/manual/dcpomatic.xml
@@ -320,7 +320,20 @@ making the DCP.</para>
<para>
Choose <guilabel>Make DCP</guilabel> from the
-<guilabel>Jobs</guilabel> menu. DCP-o-matic will encode your DCP.
+<guilabel>Jobs</guilabel> menu. Before encoding your DCP, DCP-o-matic
+will run a series of checks on your film to look for various conditions
+that might cause problems when playing back the DCP. If any potential
+problems are found, DCP-o-matic will show you a list of hints.
+Each hint describes the condition that was found and gives
+advice on how to resolve it. If hints are found and reported, you can
+either <guilabel>Make DCP</guilabel> anyway (without adjusting any
+settings), or <guilabel>Go back</guilabel> in order to make
+adjustments before encoding the DCP.
+</para>
+
+<para>
+If no hints were found (or you pressed <guilabel>Make DCP</guilabel>
+after hints were displayed), DCP-o-matic will encode your DCP.
This may take some time (many hours in some cases). While the job is
in progress, DCP-o-matic will update you on how it is getting on with
the progress bar in the bottom of its window, as shown in <xref