Documentation

Unity Version Control

CHANGESET EDITCOMMENT

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

Description

Modifies the comment of a changeset.

Usage

cm changeset editcomment | edit <csetspec> (<new_comment> | -commentsfile=<comments_file>)

Options

Option / Argument

Description

csetspecThe target changeset whose comment will be edited. (Use 'cm help objectspec' to learn more about changeset specs.)
new_commentThe new comment that will be added to the targeted changeset.
-commentsfile
Reads the new comment from the specified file.

Help

Remarks

  • The targeted changeset spec must be valid.
  • To clear the comment, pass an empty comment (
    ""
    ).
  • Quote a comment that contains spaces. If words are left over, or if an option takes the place of the comment, the command shows its usage and leaves the comment unchanged.

Examples

cm changeset editcomment cs:15@myrepo "I forgot to add the checkin details"
cm changeset edit cs:cb11ecdb-1aa9-4f11-8698-dcab14e5885a "This comment text will replace the previous one."
cm changeset edit "89095131-895d-4173-9440-ff9ef9b2538d@project@cloud" "Changing my comment"
cm changeset editcomment cs:15@myrepo -commentsfile=comment.txt