git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: Submodules or similar for exercise/exam management

From
Thomas Rast <trast@student.ethz.ch>
Date
Nov 22, 2010, 13:56 UTC
Message-ID
<201011221456.19784.trast@student.ethz.ch>
In-Reply-To
<20101118234916.GB21621@burratino>
Jonathan Nieder wrote:
Show 15 quoted lines
> Junio C Hamano wrote:
> > Jens Lehmann <Jens.Lehmann@web.de> writes:
> 
> >>> 3) never need to be aware of repo boundaries or manipulate sub-repo
> >>
> >> I think that this requirement is the hardest for any solution I know
> >> of or can imagine, as you hit these boundaries sooner or later either
> >> when you want to commit, push and/or when you have to resolve merge
> >> conflicts.
> >
> > Just a quick sanity check.  When this "requirement" makes sense, does the
> > whole thing need to be a superproject with bunch of submodules, and why?
> 
> In this example: because the submodule represents individual
> questions that are used by multiple exams.
Indeed.

I tried to not go too deeply into the status quo to keep the original mail short, but if you really care, here goes (there's nothing else below this point so you can also stop reading):

In my own group (theoretical CS), we have a Big Ugly SVN repository with a directory per class taught, with subdirectories for the exercises of every year. Either at the beginning or during the year, we copy the previous exercises and solutions to a new directory and modify/fix them to taste. Similar for exams.

This works reasonably well because all our lectures are on mostly disjoint topics, so we rarely share anything between them. The directories act more as a "tag" of the old version than anything else, and also help lazy users find the old version without talking to SVN. Converting it to git would be fairly trivial since the usage maps straight to lecture-projects with tags at the end of every semester, but largely due to inertia nobody wants to do it.

The statistics institute where my colleague works is different in two major respects.

First, they do not currently have any kind of enforced versioning. There apparently are a bunch of directories along similar lines as the above, but they live on a big shared NFS and thus it's easy to lose existing state simply by overwriting it. This is good for the purposes of this discussion because we can weigh the pain of living with the existing solution against the pain of using the new solution ;-)

More importantly, and this spawned my question, they have a lot more overlaps between lectures. (I assume this is because they give statistics courses at various levels of difficulty to various other departments/subjects of study, but I don't really know.)

Thus it often happens that an exercise is copied from lecture A to B, then later some mistake is fixed in A and the fix does not propagate. Worse, for whatever reason they might later copy back the exercise from B to A and thus have a regression.

Handling at least this case sanely would already be good. The requirement that Junio criticized above is geared not towards sanity of the use-case, but towards not making adoption so complicated as to make it impossible.

It is true that in cases where submodules really pay off, such exercises (or perhaps more realistically, guides and lecture notes) being customized slightly for each course. This would need branches. For now I am putting this case a bit into the background since it can be solved by working on such documents in a separate repo, splitting the customizations into branches and merging the fixes from the main copy; and then just binding the appropriate version as a sub-repo.

And yes, this would in theory also go for books as you described:
Show 18 quoted lines
> suppose a certain chapter is part of multiple works I have
> published --- maybe in an article and a larger book.  When working on
> the book:
> 
>  - I do not want to make changes to that chapter and forget to commit
>    them.
> 
>  - After making changes to many chapters, I do not want the fuss of
>    going from chapter to chapter and commiting them one by one.
> 
>  - I certainly do not want to publish a version of the book that
>    "includes" versions of the chapters as dead links, so to speak.
>    That is, when I publish the current version of the book, I want
>    to publish the current version of all chapters, too.
> 
>  - When starting work on the book again after long absence, I would
>    like to be able to see and have the chance to adopt changes to
>    chapters made as part of this book and as part of others.

Though I wonder how that pans out in practice since it is rarely possible to just "drop in" a chapter without rewriting significant parts of it to match the rest of the book.

-- 
Thomas Rast
trast@{inf,student}.ethz.ch
Previous: Jonathan Nieder
Message 7 of 7 in “Submodules or similar for exercise/exam management”
  1. Thomas RastNov 18, 2010
  2. Seth RobertsonNov 18, 2010
  3. Thomas RastNov 22, 2010
  4. Jens LehmannNov 18, 2010
  5. Junio C HamanoNov 18, 2010
  6. Jonathan NiederNov 18, 2010
  7. Thomas RastNov 22, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.