[PATCH 1/5] documentation: mention gitk font adjustment in tutorial

Subsystems: documentation, the rest

DORMANTno replies

5 messages, 1 author, 2016-06-15 · open the first message on its own page

[PATCH 1/5] documentation: mention gitk font adjustment in tutorial

From: <hidden>
Date: 2016-06-15 22:42:27

From: J. Bruce Fields <redacted>

Kind of silly, but the font I get by default in gitk makes it mostly
unusable for me, so this is the first thing I'd want to know about.
(But maybe there's a better suggestion than just Ctrl-='ing until
satisfied.)

Signed-off-by: J. Bruce Fields <redacted>

---

ded59a62d1d7b114cdc4d5352e89006880e94f08
 Documentation/tutorial.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

ded59a62d1d7b114cdc4d5352e89006880e94f08
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index 79781ad..5fdeab9 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -429,7 +429,9 @@ visualizing their history.  For example,
 -------------------------------------
 
 allows you to browse any commits from the last 2 weeks of commits
-that modified files under the "drivers" directory.
+that modified files under the "drivers" directory.  (Note: you can
+adjust gitk's fonts by holding down the control key while pressing
+"-" or "+".)
 
 Finally, most commands that take filenames will optionally allow you
 to precede any filename by a commit, to specify a particular version
-- 
1.3.3.gff62

[PATCH 5/5] Documentation: fix a tutorial-2 typo

From: <hidden>
Date: 2016-06-15 22:42:27

From: J. Bruce Fields <redacted>

Fix a typo.

Signed-off-by: J. Bruce Fields <redacted>

---

2506b48d2aee595a5023d31166a64d4d28bf8789
 Documentation/tutorial-2.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

2506b48d2aee595a5023d31166a64d4d28bf8789
diff --git a/Documentation/tutorial-2.txt b/Documentation/tutorial-2.txt
index 08d3453..9c9500c 100644
--- a/Documentation/tutorial-2.txt
+++ b/Documentation/tutorial-2.txt
@@ -377,7 +377,7 @@ At this point you should know everything
 pages for any of the git commands; one good place to start would be
 with the commands mentioned in link:everyday.html[Everyday git].  You
 should be able to find any unknown jargon in the
-link:glossary.html[Glosssay].
+link:glossary.html[Glossary].
 
 The link:cvs-migration.html[CVS migration] document explains how to
 import a CVS repository into git, and shows how to use git in a
-- 
1.3.3.gff62

[PATCH 4/5] Documentation: rewrite the core-tutorial introduction

From: <hidden>
Date: 2016-06-15 22:42:27

From: J. Bruce Fields <redacted>

Revise for conciseness, clarify the intended audience.

Signed-off-by: J. Bruce Fields <redacted>

---

3bb93812a96e602729e52ab1ac5a555f453470be
 Documentation/core-tutorial.txt |   30 +++++++++---------------------
 1 files changed, 9 insertions(+), 21 deletions(-)

3bb93812a96e602729e52ab1ac5a555f453470be
diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt
index 5a831ad..3ab3317 100644
--- a/Documentation/core-tutorial.txt
+++ b/Documentation/core-tutorial.txt
@@ -4,35 +4,23 @@ A git core tutorial for developers
 Introduction
 ------------
 
-This is trying to be a short tutorial on setting up and using a git
-repository, mainly because being hands-on and using explicit examples is
-often the best way of explaining what is going on.
+If you primarily interested in using git to manage your own projects,
+see link:tutorial.txt[A tutorial introduction to git] before reading
+this.
 
-In normal life, most people wouldn't use the "core" git programs
-directly, but rather script around them to make them more palatable. 
-Understanding the core git stuff may help some people get those scripts
-done, though, and it may also be instructive in helping people
-understand what it is that the higher-level helper scripts are actually
-doing. 
+However, git also provides commands that provide low-level access to
+git internals.  These "core" git commands will be useful to advanced
+users, to git hackers, and to anyone developing software on top of
+the git core.
 
 The core git is often called "plumbing", with the prettier user
 interfaces on top of it called "porcelain". You may not want to use the
 plumbing directly very often, but it can be good to know what the
 plumbing does for when the porcelain isn't flushing.
 
-The material presented here often goes deep describing how things
-work internally.  If you are mostly interested in using git as a
-SCM, you can skip them during your first pass.
-
-[NOTE]
-And those "too deep" descriptions are often marked as Note.
-
 [NOTE]
-If you are already familiar with another version control system,
-like CVS, you may want to take a look at
-link:everyday.html[Everyday GIT in 20 commands or so] first
-before reading this.
-
+Notes like this mark descriptions of deep git internals that can
+be skipped on a first reading.
 
 Creating a git repository
 -------------------------
-- 
1.3.3.gff62

[PATCH 3/5] Documentation: retitle the git-core tutorial

From: <hidden>
Date: 2016-06-15 22:42:27

From: J. Bruce Fields <redacted>

Give the git-core tutorial a name that better reflects its intended
audience.

Signed-off-by: J. Bruce Fields <redacted>

---

cbec3d5696e6c9fa5a44046e1cd1c870681c6897
 Documentation/core-tutorial.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

cbec3d5696e6c9fa5a44046e1cd1c870681c6897
diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt
index d1360ec..5a831ad 100644
--- a/Documentation/core-tutorial.txt
+++ b/Documentation/core-tutorial.txt
@@ -1,5 +1,5 @@
-A short git tutorial
-====================
+A git core tutorial for developers
+==================================
 
 Introduction
 ------------
-- 
1.3.3.gff62

[PATCH 2/5] documentation: add brief mention of cat-file to tutorial part I

From: <hidden>
Date: 2016-06-15 22:42:27

From: J. Bruce Fields <redacted>

I'd rather avoid git cat-file so early on, but the

	git-cat-file -p old-commit:/path/to/file

trick is too useful....

Also fix a nearby typo while we're at it.

Signed-off-by: J. Bruce Fields <redacted>

---

e47d8a459f0a2407304c9b7165b30746baa7fe29
 Documentation/tutorial.txt |    8 +++++++-
 1 files changed, 7 insertions(+), 1 deletions(-)

e47d8a459f0a2407304c9b7165b30746baa7fe29
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index 5fdeab9..039a859 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -435,12 +435,18 @@ adjust gitk's fonts by holding down the 
 
 Finally, most commands that take filenames will optionally allow you
 to precede any filename by a commit, to specify a particular version
-fo the file:
+of the file:
 
 -------------------------------------
 $ git diff v2.5:Makefile HEAD:Makefile.in
 -------------------------------------
 
+You can also use "git cat-file -p" to see any such file:
+
+-------------------------------------
+$ git cat-file -p v2.5:Makefile
+-------------------------------------
+
 Next Steps
 ----------
 
-- 
1.3.3.gff62
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help