Merge pull request #1402 from djmitche/rtype-log-docs

Fix docs for appendLog
buildbot · Dec 2, 2014 · d983a26 · d983a26
2 parents 367acfd + 3144ea5
commit d983a26
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 14 deletions.
diff --git a/master/docs/developer/rtype-log.rst b/master/docs/developer/rtype-log.rst
@@ -115,7 +115,7 @@ Logs
 Update Methods
 --------------
 
-All update methods are available as attributes of ``master.data.logs``.
+All update methods are available as attributes of ``master.data.updates``.
 
 .. py:class:: buildbot.data.logs.LogResourceType
 
@@ -130,6 +130,14 @@ All update methods are available as attributes of ``master.data.logs``.
         The name need not be unique.
         This method will generate a unique slug based on the name.
 
+    .. py:method:: appendLog(logid, content):
+
+        :param integer logid: the log to which content should be appended
+        :param unicode content: the content to append
+
+        Append the given content to the given log.
+        The content must end with a newline.
+
     .. py:method:: finishLog(logid)
 
         :param integer logid: the log to finish

diff --git a/master/docs/developer/rtype-logchunk.rst b/master/docs/developer/rtype-logchunk.rst
@@ -32,9 +32,8 @@ Logchunks
 
     .. note::
 
-        .. bb:event:: *.logchunk.new
-
-            There will be no new chunk event, the log rtype will be updated when new chunk is created, and the ui will call the data api to get actual data. This avoids to flood the mq with logchunk data.
+        There is no event for a new chunk. Instead, the log resource is updated when new chunks are added, with the new number of lines.
+        Consumers can then request those lines, if desired.
 
     .. bb:rpath:: /log/:logid/contents
 
@@ -118,14 +117,5 @@ Raw endpoints
 Update Methods
 --------------
 
-All update methods are available as attributes of ``master.data.logchunks``.
-
-.. py:class:: buildbot.data.logchunks.LogChunkResourceType
-
-    .. py:method:: appendLog(logid, content):
-
-        :param integer logid: the log to which content should be appended
-        :param unicode content: the content to append
+Log chunks are updated via :doc:`rtype-log`.
 
-        Append the given content to the given log.
-        The content must end with a newline.