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

Re: [StGit PATCH 6/6] Refresh and expand the tutorial (not finished)

From
Karl Hasselström <kha@treskal.com>
Date
Oct 7, 2008, 07:12 UTC
Message-ID
<20081007071223.GC31332@diana.vm.bytemark.co.uk>
In-Reply-To
<b0943d9e0810061425u3ead1de5re1a252f03c2d09b3@mail.gmail.com>
On 2008-10-06 22:25:45 +0100, Catalin Marinas wrote:
Show 11 quoted lines
> 2008/10/5 Karl Hasselström <kha@treskal.com>:
>
> > This is a first pass at expanding the tutorial, fixing its
> > formatting, and updating it with the new things that have happened
> > in StGit.
> >
> > There are a number of things still left to do in the second half
> > of the document; they are tagged with "TODO".
>
> Thanks for this. Even with the TODOs, I think we can merge them into
> the master branch so that I have the same copy as you.

OK, that makes sense; "master" is, after all, a development branch. A stable development branch, but still a development branch.

> Do you plan to do more work on the tutorial (so that we don't
> duplicate)?

I was planning to finish it if nobody else stepped up. But it'd be great if I didn't have to do it alone. :-)

I guess we can avoid duplicate work if we send out a mail saying "I'll now be working on part XXX" before we start writing.

Show 5 quoted lines
> > -Layout of the .git directory
>
> Should we mention the metadata storage somewhere? This is probably
> too advanced for the tutorial but might be useful to have it in a
> development document (for other to understand where we keep things).
Yes, probably.
> Actually, is the automatically generated documentation from the new
> infrastructure enough?

I doubt it. It probably could be made enough, though, but I don't know if that'd be better or worse than a separate document -- the code documentation is tightly tied to the code, and I'm not sure if we want that in this case.

We can let whoever writes it decide.
-- 
Karl Hasselström, kha@treskal.com
      www.treskal.com/kalle
Previous: Catalin MarinasNext: Karl Hasselström
Message 18 of 19 in “Documentation updates”
  1. 0/6 Documentation updatesKarl Hasselström, Oct 5, 2008
  2. 1/6 Remove unused variableKarl Hasselström, Oct 5, 2008
  3. 2/6 Remove TODO items that have already been addressedKarl Hasselström, Oct 5, 2008
  4. Catalin MarinasOct 6, 2008
  5. Karl HasselströmOct 7, 2008
  6. 3/6 We're half-way there with the separate indexesKarl Hasselström, Oct 5, 2008
  7. 4/6 Add 1.0 TODO items from recent discussion by private mailKarl Hasselström, Oct 5, 2008
  8. Catalin MarinasOct 6, 2008
  9. Karl HasselströmOct 7, 2008
  10. 5/6 Refresh the main stg man pageKarl Hasselström, Oct 5, 2008
  11. Catalin MarinasOct 6, 2008
  12. Samuel TardieuOct 6, 2008
  13. Karl HasselströmOct 7, 2008
  14. Catalin MarinasOct 6, 2008
  15. Karl HasselströmOct 7, 2008
  16. 6/6 Refresh and expand the tutorial (not finished)Karl Hasselström, Oct 5, 2008
  17. Catalin MarinasOct 6, 2008
  18. Karl HasselströmOct 7, 2008
  19. Karl HasselströmOct 8, 2008

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.