[PATCH] git-worktree.txt: Fix typo "to"/"two", add comma

2016-11-12 Thread Ben North
Signed-off-by: Ben North <b...@redfrontdoor.org>
---
 Documentation/git-worktree.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 0aeb020..e257c19 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -133,7 +133,7 @@ OPTIONS
 +
 If the last path components in the working tree's path is unique among
 working trees, it can be used to identify worktrees. For example if
-you only have to working trees at "/abc/def/ghi" and "/abc/def/ggg",
+you only have two working trees, at "/abc/def/ghi" and "/abc/def/ggg",
 then "ghi" or "def/ghi" is enough to point to the former working tree.

 DETAILS
-- 
2.9.3


Re: Literate programming with git

2016-09-03 Thread Ben North
Hi Stefan,

Thanks for the remarks.

>> https://github.com/bennorth/git-dendrify
>
> [...]  You get an easy top-level overview what
> the community is interested in via e.g.:
>
> git log --first-parent --oneline
>
> That would be equivalent to showing only
> * Add printing facility
>
> If you run that command on "* Add printing facility"^2
> you would see the headlines of the section.

That's a nice observation on how to use the existing git tools to view a
structured history with different levels of detail.

> However in gits reality we do not have these nice sections
> building on top of each other, as many people are interested in
> different things and build where they see fit.

Yes, reality isn't always clean!  But each individual contributor can
structure their own branch in a hierarchical way if they think it would
be helpful, before publishing it for review.

> How does the linearify/dendrify work with already non-linear history?

If you attempt to 'linearize' a section of history which isn't of the
required hierarchical form, the tool exits without doing anything.
(Because this is only at the experimenting stage, there may well be
situations where it fails to detect an unexpected structure, but see
also next paragraph.)  Similarly, if you attempt to 'dendrify' a section
of history which isn't purely linear, it refuses.

In any case, the tool only ever creates a new branch so your original
history is unaltered.

Thanks,

Ben.


Literate programming with git

2016-08-31 Thread Ben North
Hi,

I've recently been experimenting with using git to make software more
human-readable.  Presenting software for humans to read is not a new
idea (Knuth's 'literate programming'), but I think git can be a new
tool for showing the development of code in a structured way.
Merge-commits can break a flat sequence of commits into sections and
subsections, in the same way that a document's paragraphs are
arranged.  The hierarchical organisation is helpful when reading the
history, and also allows that history to be rendered into a structured
document explaining the code's development.

As a demo, I've created:

http://www.redfrontdoor.org/20160813-literate-git-demo/index.html

This was generated directly from the git repo of the project, using
tools I wrote:

https://github.com/bennorth/literate-git

For working with hierarchical git histories, I wrote another tool:

https://github.com/bennorth/git-dendrify

The READMEs of the two projects give more details of these ideas.

This is at the prototype / proof-of-concept stage --- any feedback welcome!

Thanks,

Ben.


[PATCH] gitignore.txt: fix spelling of backslash

2014-11-04 Thread Ben North
Signed-off-by: Ben North b...@redfrontdoor.org
---
 Documentation/gitignore.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index 8734c15..09e82c3 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -77,7 +77,7 @@ PATTERN FORMAT
Put a backslash (`\`) in front of the first hash for patterns
that begin with a hash.

- - Trailing spaces are ignored unless they are quoted with backlash
+ - Trailing spaces are ignored unless they are quoted with backslash
(`\`).

  - An optional prefix `!` which negates the pattern; any
-- 
1.8.3.2
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html