[OpenAFS-devel] GSOC Project 2025 on Command Line Completion

[Michael Meffie]

On Thu, 13 Mar 2025 13:25:36 +0530
Satyarth Singh <satyarthsingh115@gmail.com> wrote:

> Dear OpenAFS team,
> I am Satyarth Singh, a B.TECH student in Computer Science, interested in
> working on the project titled Command Line Completion for OpenAFS CLI. I
> have knowledge of both C programming and Shell Scripting which i am also
> improving. I want to ask a few questions so that I can understand the exact
> requirements and thus refine my proposal.

Hello Satyarth,

Thank you for your interest in OpenAFS.

> 1) Are there any specific commands that should be given more priority?

The most commonly used commands are likely to be fs, vos, pts, bos
commands, each of which have many subcommands. See the man pages for details.

All of the command line programs in OpenAFS use an internal library to
process the command line arguments called "libcmd". The code is available
in src/cmd in the OpenAFS code tree.  One interesting feature of libcmd
is it can allow the user to specify options as positional arguments
as shortcut!

> 2) Is there any existing work been done on Bash/ZSH completion for OpenAFS?
> If so, where can I find it?

I know there was at some point, but it was not included in the OpenAFS
project.

> 3) What is the preferred contribution process for this project? Should I
> work on a separate branch or submit patches for review?

You will likely want to work an a separate branch at first. We use
gerrit.openafs.org for code reviews, after your branch is ready for
reviews to be merged.  See the OpenAFS Contributor's Guide for more
info.

> 4) Are there any OpenAFS contributors or mentors who could provide
> additional guidance or with who I should collaborate with?

We have several volunteers for mentors to collaborate with. If you
have specific questions do not hesitate to ask on this list.

Many thanks,
Mike



-- 
Michael Meffie <mmeffie@sinenomine.net>