OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-notes.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-notes(1)">\r
5 <articleinfo>\r
6     <title>git-notes(1)</title>\r
7         <indexterm>\r
8                 <primary>git-notes(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-notes - Add/inspect commit notes</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git-notes</emphasis> (edit | show) [commit]</literallayout>\r
19 </blockquote>\r
20 </simplesect>\r
21 <simplesect id="_description">\r
22 <title>DESCRIPTION</title>\r
23 <simpara>This command allows you to add notes to commit messages, without\r
24 changing the commit.  To discern these notes from the message stored\r
25 in the commit object, the notes are indented like the message, after\r
26 an unindented line saying "Notes:".</simpara>\r
27 <simpara>To disable commit notes, you have to set the config variable\r
28 core.notesRef to the empty string.  Alternatively, you can set it\r
29 to a different ref, something like "refs/notes/bugzilla".  This setting\r
30 can be overridden by the environment variable "GIT_NOTES_REF".</simpara>\r
31 </simplesect>\r
32 <simplesect id="_subcommands">\r
33 <title>SUBCOMMANDS</title>\r
34 <variablelist>\r
35 <varlistentry>\r
36 <term>\r
37 edit\r
38 </term>\r
39 <listitem>\r
40 <simpara>\r
41         Edit the notes for a given commit (defaults to HEAD).\r
42 </simpara>\r
43 </listitem>\r
44 </varlistentry>\r
45 <varlistentry>\r
46 <term>\r
47 show\r
48 </term>\r
49 <listitem>\r
50 <simpara>\r
51         Show the notes for a given commit (defaults to HEAD).\r
52 </simpara>\r
53 </listitem>\r
54 </varlistentry>\r
55 </variablelist>\r
56 </simplesect>\r
57 <simplesect id="_author">\r
58 <title>Author</title>\r
59 <simpara>Written by Johannes Schindelin &lt;<ulink url="mailto:johannes.schindelin@gmx.de">johannes.schindelin@gmx.de</ulink>&gt;</simpara>\r
60 </simplesect>\r
61 <simplesect id="_documentation">\r
62 <title>Documentation</title>\r
63 <simpara>Documentation by Johannes Schindelin</simpara>\r
64 </simplesect>\r
65 <simplesect id="_git">\r
66 <title>GIT</title>\r
67 <simpara>Part of the git<ulink url="git">7</ulink> suite</simpara>\r
68 </simplesect>\r
69 </article>\r