From 9c84be01adfcfbfee190c31fd9967ca2377e60d5 Mon Sep 17 00:00:00 2001 From: Richard Brooksby Date: Tue, 5 Apr 2016 11:36:31 +0100 Subject: [PATCH] Adding advice about what to put in the version branch description. Copied from Perforce Change: 190709 ServerID: perforce.ravenbrook.com --- mps/procedure/version-create.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/mps/procedure/version-create.rst b/mps/procedure/version-create.rst index 8715598435f..593c470cbfb 100644 --- a/mps/procedure/version-create.rst +++ b/mps/procedure/version-create.rst @@ -97,9 +97,13 @@ Run the script ``tool/branch``, passing the options: * ``-p master`` — parent branch * ``-C CHANGELEVEL`` — changelevel at which to make the branch * ``-v`` — request a version branch -* ``-d "DESCRIPTION"`` — description of the branch +* ``-d "DESCRIPTION"`` — description of the branch (see below) * ``-y`` — yes, really create the branch +The branch description will be published in the version index and +should be a short summary of the improvements detailed in the release +notes. + If omitted, the project and parent branch are deduced from the current directory, and the changelevel defaults to the most recent change on the parent branch. A typical invocation looks like this::