Documentation

Unity Version Control

BRANCH EDITCOMMENT

Edit branch comments with the Unity Version Control CLI.
Read time 1 minuteLast updated 7 days ago

Description

Modifies the comment of a branch.

Usage

cm branch | br editcomment | edit <brspec> (<new_comment> | -commentsfile=<comments_file>)

Options

Option / Argument

Description

brspecThe branch whose comment will be edited. (Use
cm help objectspec
to learn more about branch specs.)
new_commentThe new comment for the branch.
-commentsfile
Reads the new comment from the specified file.

Help

Remarks

  • To clear the comment, pass an empty comment (
    ""
    ).
  • edit
    is an alias of
    editcomment
    . To create a branch named "edit", use
    cm branch create edit
    .

Examples

The following example replaces the comment of branch
/main/task001
:
cm branch editcomment /main/task001 "Fix the login timeout"