GSoC Week 1



A warm entrance

It has been a good week. The Google Summer of Code '20 results were announced and I along with two fellow countrymen Hariom and Abhishek made it. Congratulations to all! ;)

I had intended to start my project before the results were announced irrespective of my selection, and so far things seem good! I am done with the porting of set-url from shell to C and it is in its final stages of review by Christian, Junio and Denton (at the time of writing the blog it has entered the pu branch of git/git).

In the premier week I have been:

  1. Working on gitfaq. As the name suggests, it consists of various commonly asked questions about the Git suite. 2 out of 4 commits have been queued and now my goal lies in working out the rest 2 commits so that they are queued as well.
  2. Working on set-branch subcommand of git submodule.

Let’s explore (2) a bit more:

What is set-branch?

Quoting from the official Documentation:

Sets the default remote tracking branch for the submodule. The --branch option allows the remote branch to be specified. The --default option removes the submodule..branch configuration key, which causes the tracking branch to default to master.

Hence, it helps to set the branch of the submodule in question. My job here is to convert the subcommand from shell to C. The test responsible to check the correct functioning of the command is t7419.

What is my progress?

At the time of writing this blog (May 9, 2330h IST), my progress is as follows:

  • Created the basic scaffolding for the command (declaring the required variables & argument parsing)
  • Implemented (or did I? More on that below) the branch option.
  • Implemented (or did I? More on that below) the default option.
  • Removed the shell script part of the subcommand from .gitsubmodule.sh.
  • Added the subcommand in the cmd_struct[] structure.

The difficulties

Alright, so the problem which I am facing is as follows (I will describe it in terms of the test so that it is easy to understand as well as explain). t7419 has the following 6 tests:

  1. submodule config cache setup
  2. ensure submodule branch is unset
  3. test submodule set-branch --branch
  4. test submodule set-branch --default
  5. test submodule set-branch -b
  6. test submodule set-branch -d

Tests 1&2 are responsible for setting up the repository and hence pass irrespective of the set-branch implementation. Only tests 3&5 are failing (surprising it may seem?). The thing is that, the core function which being used to set the config in .gitmodules, config_set_in_gitmodules_file_gently, sets the value of a configuration only if it exists in the first place. I discovered this while debugging the errors, by doing a cat .gitmodules, observing that an entry was never even made in the first place for the branch. Hilariously, this is the exact reason tests 4&6 are passing. The default option’s goal is to remove the submodule.<name>.branch section, thus making the branch as master by default. Now, as my implementation of the branch option is not actually inserting any entry, the default option does not get the chance to see any entry in fact, thus passing the tests.

Next steps

Thankfully, as I have discovered the root cause of the problem here, my goal now is to create a mechanism which will make a submodule.<name>.branch entry in .gitmodules if one does not exist and update it with the branch desired in the arguments of the subcommand. Similarly, I will have to ensure that the default option deletes the aforementioned entry if it exists.

The community has been very welcoming with support coming in from so many people. Feels at home! :’)

Thank you Git! Looking forward to tons of contributions ;)

Over and out,
Shourya Shukla

Location: Roorkee, Uttarakhand, India

Comments

Post a Comment

Popular posts from this blog

The Final Report

The Final Report This blog will describe my GSoC project along with a small account of how I started contributing to Git. My GSoC '20 project was to convert 'submodule' to a builtin by porting it from shell to C. Initially, Git commands were written in shell with some instances of Perl as well. As times progressed, various platforms to run Git emerged & projects became large (spanning millions of lines of code), enter, problems in production level code, such as: Difficulties in portability of code. The submodule shell script uses commands such as echo, grep, cd, test and printf to name a few. When switching to non-POSIX compliant systems, one will have to use emulation layers to implement such commands on the system. Which is a lot of extra work. There is large overhead involved in calling the command . As these commands implemented in shell script are not buitlins, they tend to call multiple fork() and exec() syscalls for creating more child p...
Read more

GSoC Week 4 [One month special]

 One month complete! A month has passed now since GSoC started (it will on June 4) and it is a fine milestone I think! I feel happy about it. This week was more about studying things and what is under the hood rather than programming something like it has been always. I was stuck with the callback mechanism of the submodule code. I could not understand the purpose behind it and thought that it was not needed. But as always, the things which confuse me are the ones with very simple and crystal clear logic behind them (but again, not to fret, we learn to walk by falling over and over right?); I will cover the callback mechanism in the blog so that anyone who ever wants to work on submodules or a future student like me has some reference to what is going on. What are callbacks? Callbacks are defined in regard to a function or a segment of a program you call when encountered with a particular trigger (such as an if statement or end of function). And by “you call”, I ...
Read more

GSoC Week 10

Addressing comments on my patch I spent this week addressing the suggestions made by Johannes which, were extremely detailed and long. I am done with most of the suggestions so I will highlight some important ones and what I learned from them. This week, I saw the ocean for I guess the first time in my life and it was a totally unique experience! Peaceful Seas Moving to the comments made by Johannes. Eliminate find_unique_abbrev() The shell version of summary calls git rev-parse twice for two jobs which are: Checking for a missing_src and a missing_dst i.e. , the missing source and destination committish. test $mod_src = 160000 && ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_src^0 >/dev/null && missing_src=t test $mod_dst = 160000 && ! GIT_DIR="$name/.git" git rev-parse -q --verify $sha1_dst^0 >/dev/null && missing_dst=t Quoting my mentor Kaartic: The above code assigns missi...
Read more