Shourya ShuklaHello all!
This is the sixth installation of my weekly blog covering what I have learned in GSoC and other like stuff. https://shouryashukla.blogspot.com/2020/06/gsoc-week-55.html
Feel free to comment!
Regards, Shourya Shukla
Shourya Shukla
Kaartic SivaraamRe: [GSoC] Shourya's Blog
Hi Shourya,
On 16-06-2020 12:51, Shourya Shukla wrote:
Show 8 quoted lines
> Hello all! > > This is the sixth installation of my weekly blog covering what I have > learned in GSoC and other like stuff. > https://shouryashukla.blogspot.com/2020/06/gsoc-week-55.html > > Feel free to comment! >
Some things I noted in the blog:
> As far as I have learned, summary prints a git log --oneline > between the revision checked out in the submodule and the > revision superproject assumed the submodule to be in (i.e., > the one checked out in the superproject).
The explanation is pretty close. The wording could be tweaked a little to be more precise. Particularly "assume" isn't a proper word to explain the working of summary. It works based on facts not assumptions. Something along the lines of:
As far as I have learned, summary prints a git log --oneline
between the revision checked out in the submodule and the revision
"known" to the superproject (i.e., the revision found in the index
of the superproject).> If no revision is specified of the submodule then we assume it to be HEAD
As discussed elsewhere, the revision passed to the summary command is the revision of the superproject and not the revision of the submodule.
Show 5 quoted lines
> $ git submodule summary my-subm > * my-subm abc123..def456 > < some commit > < another commit > < some another commit
While the command above would produce the result you mention when 'my-subm' in the repo. The command itself is incorrect if it's intention is to print "only" the summary of 'my-subm'. This is the format of the 'summary' sub-command according to the doc:
summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]
So, it expects a 'commit' followed by the 'path'. As you had passed the path as the first argument it would be treated as the 'commit' argument. As 'my-subm' is likely not a valid commit-ish, the script would default to 'HEAD' (the final else mentioned below) and would print the summary of all the submodules. IOW, it just prints the same output as:
$ git submodule summary
in this case.
Show 7 quoted lines
> elif test -z "$1" || test "$1" = "HEAD" > then > # before the first commit: compare with an empty tree > head=$(git hash-object -w -t tree --stdin </dev/null) > test -z "$1" || shift > > This part checks if there are any commits in our tree (of the submodule) or not.
Again, it's the tree of the superproject that we're concerned about.
> If there aren’t any commits then it simulates an empty repo environment > using head=$(git hash-object -w -t tree --stdin </dev/null). The > /dev/null is the UNIX null device and is sort of a blackhole meaning > things if gone into it completely disappear never to be seen again.
Fine. As we're using '/dev/null' as an input here. It would've been nice if you had also mentioned that it serves as a "convenient empty file for input streams"[1] because "reads from /dev/null always return end of file"[2].
> Making stdin as /dev/null means giving nothing as input hence > nothing to create a hash object of.
Not precise. That command would return the hash of an empty tree.
Show 7 quoted lines
> else > head="HEAD" > fi > > This means that if the above 2 cases fail (which will most probably > lead to presence of commits yet a failure in git rev-parse --verify) > then make head as HEAD.
Characterising 'git rev-parse --verify ...' as not being able to print the hash of a commit even when there is one in the repo seems incorrect to me. There are other more likely cases which would lead to rev-parse failing and that last else part getting executed. For instance, an incorrect ref being passed as the first argument to the summary sub-command like:
git submodule summary no-such-ref-exists
or
git submodule summary "invalid ref"
So, I think it would've been precise to just say:
This means that if the above 2 cases fail then we make
head as HEAD.[1]: https://en.wikipedia.org/wiki/Null_device [2]: https://man7.org/linux/man-pages/man4/null.4.html
-- Sivaraam
Shourya ShuklaRe: [GSoC] Shourya's Blog
On 17/06 02:08, Kaartic Sivaraam wrote:
Show 11 quoted lines
> Some things I noted in the blog: > > > As far as I have learned, summary prints a git log --oneline > > between the revision checked out in the submodule and the > > revision superproject assumed the submodule to be in (i.e., > > the one checked out in the superproject). > > The explanation is pretty close. The wording could be tweaked a little > to be more precise. Particularly "assume" isn't a proper word to > explain the working of summary. It works based on facts not > assumptions. Something along the lines of:
Thanks for the feedback. I couldn't think of a word back then! Will make amends.
Show 9 quoted lines
> As far as I have learned, summary prints a git log --oneline > between the revision checked out in the submodule and the revision > "known" to the superproject (i.e., the revision found in the index > of the superproject). > > > If no revision is specified of the submodule then we assume it to be HEAD > > As discussed elsewhere, the revision passed to the summary command is > the revision of the superproject and not the revision of the submodule.
Alright! Will amend.
Show 24 quoted lines
> > $ git submodule summary my-subm > > * my-subm abc123..def456 > > < some commit > > < another commit > > < some another commit > > While the command above would produce the result you mention when > 'my-subm' in the repo. The command itself is incorrect if it's > intention is to print "only" the summary of 'my-subm'. This is the > format of the 'summary' sub-command according to the doc: > > summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] > [<path>...] > > So, it expects a 'commit' followed by the 'path'. As you had passed the > path as the first argument it would be treated as the 'commit' argument. > As 'my-subm' is likely not a valid commit-ish, the script would > default to 'HEAD' (the final else mentioned below) and would > print the summary of all the submodules. IOW, it just prints the > same output as: > > $ git submodule summary > > in this case.
I just took the case of only one submodule existing in the superproject. Though even my output isn't wrog, the path taken to achieve it is a bit ambiguous. I will change it.
Show 19 quoted lines
> > else > > head="HEAD" > > fi > > > > This means that if the above 2 cases fail (which will most probably > > lead to presence of commits yet a failure in git rev-parse --verify) > > then make head as HEAD. > > Characterising 'git rev-parse --verify ...' as not being able to print > the hash of a commit even when there is one in the repo seems incorrect > to me. There are other more likely cases which would lead to rev-parse > failing and that last else part getting executed. For instance, an > incorrect ref being passed as the first argument to the summary > sub-command like: > > git submodule summary no-such-ref-exists > > or > git submodule summary "invalid ref"
Oh! I did not think this one! I will change this too. Thank you so much for pointing this out.
Regards, Shourya Shukla
Junio C HamanoRe: [GSoC] Shourya's Blog
Shourya Shukla <shouryashukla.oo@gmail.com> writes:
Show 7 quoted lines
> Hello all! > > This is the sixth installation of my weekly blog covering what I have > learned in GSoC and other like stuff. > https://shouryashukla.blogspot.com/2020/06/gsoc-week-55.html > > Feel free to comment!
This like looked unusual:
var1=${var1:=$var2}What's inside ${...} is sufficient to assing to var1 when it is not uset or set to an empty string. It is far more common to say
: ${var1:=$var2}with or without the colon in front of the equal sign (which tells the construct to treat "set to empty" the same way as "unset").