ID 84659 - Clarify tile render stitch and cleanup process in documentation

Problem summary

In the Batch Mode section of the Katana Online Help there are details on --tile-cleanup batch command argument, however, this is a bit misleading at present as the example uses --tile-clean instead of cleanup.
Both commands work, however, they require --tile-stitch to be present in the batch command for the clean up process to be triggered correctly. It should also be mentionied that the --tile-stitch and --tile-cleanup commands should be run after all tiles are rendered.

 

This behaviour should be clarified in this section of the docs, and a full set of example commands should be provided to illustrate the correct usage. Please see such an example below.

katana --batch --katana-file=/tmp/clean.katana --render-node=Render -t 1 --tile-render=0,0,2,2katana --batch --katana-file=/tmp/clean.katana --render-node=Render -t 1 --tile-render=0,1,2,2katana --batch --katana-file=/tmp/clean.katana --render-node=Render -t 1 --tile-render=1,0,2,2katana --batch --katana-file=/tmp/clean.katana --render-node=Render -t 1 --tile-render=1,1,2,2katana --batch --katana-file=/tmp/clean.katana --render-node=Render -t 1 --tile-render=0,0,2,2 --tile-stitch --tile-clean

Customer reported version
Katana 2.5v3

Customer reported platform
CentOS7

 

Steps to reproduce

1) Set up a simple renderable scene that includes a Render node. The minimum required is a CameraCreate node connected to a Render node.

2) Save the scene and close Katana.

3) In a terminal, run the commands specified above (if the katana alias is not set up on your machine, replace this with the path to the katana executable in KATANA_ROOT), making sure the --katana-file path points to the test scene you just saved.

The result after the first four commands should be four separate rendered tiles in the output folder specified in the Render node. After running the fifth command, there should only be one exr image stitched together from the tiles, and the separate tiles should have been deleted.