diff options
author | Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com> | 2024-04-25 18:43:29 +0200 |
---|---|---|
committer | Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com> | 2024-04-25 18:43:32 +0200 |
commit | f402f89d6ff4083134a2cb3c9f6c59d67b20e10f (patch) | |
tree | 4a3bf0e5844f944e40041e229f52123dc1e16b65 /src/buildtool/serve_api/serve_service/source_tree.hpp | |
parent | beca68227118f8adbec4395ad60647a5f9e60da5 (diff) | |
download | justbuild-f402f89d6ff4083134a2cb3c9f6c59d67b20e10f.tar.gz |
just_serve.proto: Cleanup of specification documentation
Also aligning comments in server-side headers with the proto file
documentation.
Diffstat (limited to 'src/buildtool/serve_api/serve_service/source_tree.hpp')
-rw-r--r-- | src/buildtool/serve_api/serve_service/source_tree.hpp | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/src/buildtool/serve_api/serve_service/source_tree.hpp b/src/buildtool/serve_api/serve_service/source_tree.hpp index d8d117e0..017a432d 100644 --- a/src/buildtool/serve_api/serve_service/source_tree.hpp +++ b/src/buildtool/serve_api/serve_service/source_tree.hpp @@ -35,6 +35,7 @@ #include "src/buildtool/file_system/symlinks_map/resolve_symlinks_map.hpp" #include "src/buildtool/logging/logger.hpp" +// Service for improved interaction with the target-level cache. class SourceTreeService final : public justbuild::just_serve::SourceTree::Service { @@ -81,8 +82,7 @@ class SourceTreeService final const ::justbuild::just_serve::ServeDistdirTreeRequest* request, ServeDistdirTreeResponse* response) -> ::grpc::Status override; - // Make the blob identifier of an archive content available in - // remote CAS, if blob is known. + // Make a given content blob available in remote CAS, if blob is known. // // There are no method-specific errors. auto ServeContent( @@ -90,15 +90,14 @@ class SourceTreeService final const ::justbuild::just_serve::ServeContentRequest* request, ServeContentResponse* response) -> ::grpc::Status override; - // Make a given tree identifier available in remote CAS, - // if tree is known. + // Make a given tree available in remote CAS, if tree is known. // // There are no method-specific errors. auto ServeTree(::grpc::ServerContext* context, const ::justbuild::just_serve::ServeTreeRequest* request, ServeTreeResponse* response) -> ::grpc::Status override; - // Checks if a Git-tree is locally known and, if found, makes it available + // Check if a Git-tree is locally known and, if found, make it available // in a location where this serve instance can build against. // The implementation should not interrogate the associated remote-execution // endpoint at any point during the completion of this request. @@ -109,8 +108,8 @@ class SourceTreeService final const ::justbuild::just_serve::CheckRootTreeRequest* request, CheckRootTreeResponse* response) -> ::grpc::Status override; - // Retrieves a given Git-tree from the CAS of the associated - // remote-execution endpoint and makes it available in a location where this + // Retrieve a given Git-tree from the CAS of the associated + // remote-execution endpoint and make it available in a location where this // serve instance can build against. // // There are no method-specific errors. |