ruby/proto/gitaly/repository_services_pb.rb in gitaly-16.6.10 vs ruby/proto/gitaly/repository_services_pb.rb in gitaly-16.7.0.pre.rc1

- old
+ new

@@ -13,11 +13,11 @@ self.marshal_class_method = :encode self.unmarshal_class_method = :decode self.service_name = 'gitaly.RepositoryService' - # RepositoryExists ... + # RepositoryExists returns whether a given repository exists. rpc :RepositoryExists, ::Gitaly::RepositoryExistsRequest, ::Gitaly::RepositoryExistsResponse # RepositorySize returns information on the complete on-disk repository size. If you need more # detailed information about the size of various sub-structures you should instead use the # repositoryInfo RPC. rpc :RepositorySize, ::Gitaly::RepositorySizeRequest, ::Gitaly::RepositorySizeResponse @@ -50,37 +50,40 @@ rpc :ObjectFormat, ::Gitaly::ObjectFormatRequest, ::Gitaly::ObjectFormatResponse # ApplyGitattributes writes the attributes from the given revision to info/attributes. # This RPC will be removed in 17.0. rpc :ApplyGitattributes, ::Gitaly::ApplyGitattributesRequest, ::Gitaly::ApplyGitattributesResponse # FetchRemote fetches references from a remote repository into the local - # repository. + # repository. The remote can be fetched via HTTP or SSH depending on the + # request options provided. rpc :FetchRemote, ::Gitaly::FetchRemoteRequest, ::Gitaly::FetchRemoteResponse - # CreateRepository ... + # CreateRepository creates a new empty repository. rpc :CreateRepository, ::Gitaly::CreateRepositoryRequest, ::Gitaly::CreateRepositoryResponse - # GetArchive ... + # GetArchive produces and returns an archive of a repository. rpc :GetArchive, ::Gitaly::GetArchiveRequest, stream(::Gitaly::GetArchiveResponse) - # HasLocalBranches ... + # HasLocalBranches returns whether the given repo contains any branches. rpc :HasLocalBranches, ::Gitaly::HasLocalBranchesRequest, ::Gitaly::HasLocalBranchesResponse # FetchSourceBranch fetches a branch from a second (potentially remote) # repository into the given repository. rpc :FetchSourceBranch, ::Gitaly::FetchSourceBranchRequest, ::Gitaly::FetchSourceBranchResponse # Fsck checks the repository for consistency via git-fsck(1). This can be used to check for # repository corruption. rpc :Fsck, ::Gitaly::FsckRequest, ::Gitaly::FsckResponse - # WriteRef ... + # WriteRef creates or updates a ref in a repository to point to a new value. rpc :WriteRef, ::Gitaly::WriteRefRequest, ::Gitaly::WriteRefResponse - # FindMergeBase ... + # FindMergeBase returns the best common ancestor between two or more commits. Consult the man + # pages of git-merge-base(1) for more information on how this is calculated. rpc :FindMergeBase, ::Gitaly::FindMergeBaseRequest, ::Gitaly::FindMergeBaseResponse # CreateFork creates a new repository from a specific source repository. This new repository will # have the same branches and tags as the source repository. Internal references will not be # recreated in the forked repository. # # all objects of the source repository will be duplicated, that is there are no space savings by # creating the repository like this. The newly created repository does not join the object pool # of the source repository, if there is any. rpc :CreateFork, ::Gitaly::CreateForkRequest, ::Gitaly::CreateForkResponse - # CreateRepositoryFromURL ... + # CreateRepositoryFromURL creates a new repo and seeds it with the contents of an existing Git repo + # reachable at the provided URL. rpc :CreateRepositoryFromURL, ::Gitaly::CreateRepositoryFromURLRequest, ::Gitaly::CreateRepositoryFromURLResponse # CreateBundle creates a bundle from all refs rpc :CreateBundle, ::Gitaly::CreateBundleRequest, stream(::Gitaly::CreateBundleResponse) # CreateBundleFromRefList creates a bundle from a stream of ref patterns. # When the bundle would be empty the FailedPrecondition error code is returned. @@ -99,45 +102,48 @@ # details about the license used in the repository. rpc :FindLicense, ::Gitaly::FindLicenseRequest, ::Gitaly::FindLicenseResponse # GetInfoAttributes reads the contents from info/attributes. # This RPC will be removed in 17.0. rpc :GetInfoAttributes, ::Gitaly::GetInfoAttributesRequest, stream(::Gitaly::GetInfoAttributesResponse) - # CalculateChecksum ... + # CalculateChecksum returns a checksum of the repository by hashing its references. Refs + # outside of well-known namespaces are not considered when computing the checksum. rpc :CalculateChecksum, ::Gitaly::CalculateChecksumRequest, ::Gitaly::CalculateChecksumResponse - # GetSnapshot ... + # GetSnapshot returns a snapshot of the repository. A snapshot comprises all Git references + # and objects required to recreate the state of a repository at a point in time. rpc :GetSnapshot, ::Gitaly::GetSnapshotRequest, stream(::Gitaly::GetSnapshotResponse) - # CreateRepositoryFromSnapshot ... + # CreateRepositoryFromSnapshot creates a new repository based on a snapshot created with + # the GetSnapshot RPC. The snapshot is fetched via HTTP. rpc :CreateRepositoryFromSnapshot, ::Gitaly::CreateRepositoryFromSnapshotRequest, ::Gitaly::CreateRepositoryFromSnapshotResponse - # GetRawChanges ... + # GetRawChanges returns metadata in raw format on the changes between two revisions. rpc :GetRawChanges, ::Gitaly::GetRawChangesRequest, stream(::Gitaly::GetRawChangesResponse) - # SearchFilesByContent ... + # SearchFilesByContent searches files in the repository using the provided grep pattern. + # For each result, the matched line is returned along with the two previous and next lines. rpc :SearchFilesByContent, ::Gitaly::SearchFilesByContentRequest, stream(::Gitaly::SearchFilesByContentResponse) - # SearchFilesByName ... + # SearchFilesByName searches files in the repository based on its name and an + # optional filter. rpc :SearchFilesByName, ::Gitaly::SearchFilesByNameRequest, stream(::Gitaly::SearchFilesByNameResponse) # RestoreCustomHooks sets the git hooks for a repository. The hooks are sent # in a tar archive containing a `custom_hooks` directory. This directory is # ultimately extracted to the repository. rpc :RestoreCustomHooks, stream(::Gitaly::RestoreCustomHooksRequest), ::Gitaly::RestoreCustomHooksResponse # SetCustomHooks sets the git hooks for a repository. The hooks are sent in a - # tar archive containing a `custom_hooks` directory. This directory is - # ultimately extracted to the repository. + # tar archive containing a `custom_hooks` directory (i.e. the response from the + # GetCustomHooksResponse RPC. This directory will be extracted into the repository. rpc :SetCustomHooks, stream(::Gitaly::SetCustomHooksRequest), ::Gitaly::SetCustomHooksResponse # BackupCustomHooks fetches the git hooks for a repository. The hooks are # sent in a tar archive containing a `custom_hooks` directory. If no hooks # are present in the repository, the response will have no data. rpc :BackupCustomHooks, ::Gitaly::BackupCustomHooksRequest, stream(::Gitaly::BackupCustomHooksResponse) # GetCustomHooks fetches the git hooks for a repository. The hooks are sent # in a tar archive containing a `custom_hooks` directory. If no hooks are # present in the repository, the response will have no data. rpc :GetCustomHooks, ::Gitaly::GetCustomHooksRequest, stream(::Gitaly::GetCustomHooksResponse) - # GetObjectDirectorySize ... + # GetObjectDirectorySize returns the size in kibibytes of the object directory of a repository. rpc :GetObjectDirectorySize, ::Gitaly::GetObjectDirectorySizeRequest, ::Gitaly::GetObjectDirectorySizeResponse # RemoveRepository will move the repository to `+gitaly/tmp/<relative_path>_removed` and # eventually remove it. This ensures that even on networked filesystems the # data is actually removed even if there's someone still handling the data. rpc :RemoveRepository, ::Gitaly::RemoveRepositoryRequest, ::Gitaly::RemoveRepositoryResponse - # RenameRepository ... - rpc :RenameRepository, ::Gitaly::RenameRepositoryRequest, ::Gitaly::RenameRepositoryResponse # ReplicateRepository replicates data from a source repository to target repository. On the # target repository, this operation ensures synchronization of the following components: # # - Git config # - Git attributes