瀏覽代碼

manifest-format.txt: Add documentation for GetManifest RPC method

Add documentation of the GetManifest RPC method in the
manifest-server section.

Change-Id: I5cda5929bc8a0ca9d3f2b9da63216427041d2823
David Pursehouse 13 年之前
父節點
當前提交
9a27d0111d
共有 1 個文件被更改,包括 10 次插入4 次删除
  1. 10 4
      docs/manifest-format.txt

+ 10 - 4
docs/manifest-format.txt

@@ -125,14 +125,15 @@ Element manifest-server
 
 
 At most one manifest-server may be specified. The url attribute
 At most one manifest-server may be specified. The url attribute
 is used to specify the URL of a manifest server, which is an
 is used to specify the URL of a manifest server, which is an
-XML RPC service that will return a manifest in which each project
-is pegged to a known good revision for the current branch and
-target.
+XML RPC service.
 
 
-The manifest server should implement:
+The manifest server should implement the following RPC methods:
 
 
   GetApprovedManifest(branch, target)
   GetApprovedManifest(branch, target)
 
 
+Return a manifest in which each project is pegged to a known good revision
+for the current branch and target.
+
 The target to use is defined by environment variables TARGET_PRODUCT
 The target to use is defined by environment variables TARGET_PRODUCT
 and TARGET_BUILD_VARIANT. These variables are used to create a string
 and TARGET_BUILD_VARIANT. These variables are used to create a string
 of the form $TARGET_PRODUCT-$TARGET_BUILD_VARIANT, e.g. passion-userdebug.
 of the form $TARGET_PRODUCT-$TARGET_BUILD_VARIANT, e.g. passion-userdebug.
@@ -140,6 +141,11 @@ If one of those variables or both are not present, the program will call
 GetApprovedManifest without the target parameter and the manifest server
 GetApprovedManifest without the target parameter and the manifest server
 should choose a reasonable default target.
 should choose a reasonable default target.
 
 
+  GetManifest(tag)
+
+Return a manifest in which each project is pegged to the revision at
+the specified tag.
+
 
 
 Element project
 Element project
 ---------------
 ---------------