Bug 598014: Document how to mark the initial comment as private when using Bug.create()

r/a=mkanat

2 files changed, 9 insertions, 4 deletions

diff --git a/Bugzilla/Bug.pm b/Bugzilla/Bug.pm
index 70f3f607d..b8178b9ce 100644
--- a/Bugzilla/Bug.pm
+++ b/Bugzilla/Bug.pm
@@ -260,6 +260,7 @@ use constant FIELD_MAP => {
     blocks           => 'blocked',
     is_confirmed     => 'everconfirmed',
     cc_accessible    => 'cclist_accessible',
+    commentprivacy   => 'comment_is_private',
     creation_time    => 'creation_ts',
     creator          => 'reporter',
     description      => 'comment',
@@ -1405,7 +1406,7 @@ sub _check_comment {
     }
 
     # Load up some data
-    my $isprivate = $params->{commentprivacy};
+    my $isprivate = delete $params->{comment_is_private};
     my $timestamp = $params->{creation_ts};
 
     # Create the new comment so we can check it
@@ -1420,9 +1421,6 @@ sub _check_comment {
         $comment->{isprivate} = $isprivate;
     }
 
-    # Don't need this anymore as it is now in the comment hash
-    delete $params->{commentprivacy};
-
     # Validate comment. We have to do this special as a comment normally
     # requires a bug to be already created. For a new bug, the first comment
     # obviously can't get the bug if the bug is created after this
diff --git a/Bugzilla/WebService/Bug.pm b/Bugzilla/WebService/Bug.pm
index 14642bca9..bfd5d5c0d 100644
--- a/Bugzilla/WebService/Bug.pm
+++ b/Bugzilla/WebService/Bug.pm
@@ -2244,6 +2244,9 @@ don't want it to be assigned to the component owner.
 
 =item C<cc> (array) - An array of usernames to CC on this bug.
 
+=item C<comment_is_private> (boolean) - If set to true, the description
+is private, otherwise it is assumed to be public.
+
 =item C<groups> (array) - An array of group names to put this
 bug into. You can see valid group names on the Permissions
 tab of the Preferences screen, or, if you are an administrator,
@@ -2322,6 +2325,10 @@ B<Required>, due to a bug in Bugzilla.
 Bugzilla 4.0, bugs were only added into Mandatory groups by this
 method.
 
+=item The C<comment_is_private> argument was added in Bugzilla B<4.0>.
+Before Bugzilla 4.0, you had to use the undocumented C<commentprivacy>
+argument.
+
 =back
 
 =back