Junio C Hamano | 944ce25 | 2018-05-30 22:25:26 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| 3 | "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 4 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 5 | <head> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 6 | <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> |
Junio C Hamano | 944ce25 | 2018-05-30 22:25:26 | [diff] [blame] | 7 | <meta name="generator" content="AsciiDoc 8.6.10" /> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 8 | <title>git-notes(1)</title> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 9 | <style type="text/css"> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 10 | /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ |
| 11 | |
| 12 | /* Default font. */ |
| 13 | body { |
| 14 | font-family: Georgia,serif; |
| 15 | } |
| 16 | |
| 17 | /* Title font. */ |
| 18 | h1, h2, h3, h4, h5, h6, |
| 19 | div.title, caption.title, |
| 20 | thead, p.table.header, |
| 21 | #toctitle, |
| 22 | #author, #revnumber, #revdate, #revremark, |
| 23 | #footer { |
| 24 | font-family: Arial,Helvetica,sans-serif; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 25 | } |
| 26 | |
| 27 | body { |
| 28 | margin: 1em 5% 1em 5%; |
| 29 | } |
| 30 | |
| 31 | a { |
| 32 | color: blue; |
| 33 | text-decoration: underline; |
| 34 | } |
| 35 | a:visited { |
| 36 | color: fuchsia; |
| 37 | } |
| 38 | |
| 39 | em { |
| 40 | font-style: italic; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 41 | color: navy; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 42 | } |
| 43 | |
| 44 | strong { |
| 45 | font-weight: bold; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 46 | color: #083194; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 47 | } |
| 48 | |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 49 | h1, h2, h3, h4, h5, h6 { |
| 50 | color: #527bbd; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 51 | margin-top: 1.2em; |
| 52 | margin-bottom: 0.5em; |
| 53 | line-height: 1.3; |
| 54 | } |
| 55 | |
| 56 | h1, h2, h3 { |
| 57 | border-bottom: 2px solid silver; |
| 58 | } |
| 59 | h2 { |
| 60 | padding-top: 0.5em; |
| 61 | } |
| 62 | h3 { |
| 63 | float: left; |
| 64 | } |
| 65 | h3 + * { |
| 66 | clear: left; |
| 67 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 68 | h5 { |
| 69 | font-size: 1.0em; |
| 70 | } |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 71 | |
| 72 | div.sectionbody { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 73 | margin-left: 0; |
| 74 | } |
| 75 | |
| 76 | hr { |
| 77 | border: 1px solid silver; |
| 78 | } |
| 79 | |
| 80 | p { |
| 81 | margin-top: 0.5em; |
| 82 | margin-bottom: 0.5em; |
| 83 | } |
| 84 | |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 85 | ul, ol, li > p { |
| 86 | margin-top: 0; |
| 87 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 88 | ul > li { color: #aaa; } |
| 89 | ul > li > * { color: black; } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 90 | |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 91 | .monospaced, code, pre { |
| 92 | font-family: "Courier New", Courier, monospace; |
| 93 | font-size: inherit; |
| 94 | color: navy; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 95 | padding: 0; |
| 96 | margin: 0; |
| 97 | } |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 98 | pre { |
| 99 | white-space: pre-wrap; |
| 100 | } |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 101 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 102 | #author { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 103 | color: #527bbd; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 104 | font-weight: bold; |
| 105 | font-size: 1.1em; |
| 106 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 107 | #email { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 108 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 109 | #revnumber, #revdate, #revremark { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 110 | } |
| 111 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 112 | #footer { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 113 | font-size: small; |
| 114 | border-top: 2px solid silver; |
| 115 | padding-top: 0.5em; |
| 116 | margin-top: 4.0em; |
| 117 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 118 | #footer-text { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 119 | float: left; |
| 120 | padding-bottom: 0.5em; |
| 121 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 122 | #footer-badges { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 123 | float: right; |
| 124 | padding-bottom: 0.5em; |
| 125 | } |
| 126 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 127 | #preamble { |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 128 | margin-top: 1.5em; |
| 129 | margin-bottom: 1.5em; |
| 130 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 131 | div.imageblock, div.exampleblock, div.verseblock, |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 132 | div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, |
| 133 | div.admonitionblock { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 134 | margin-top: 1.0em; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 135 | margin-bottom: 1.5em; |
| 136 | } |
| 137 | div.admonitionblock { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 138 | margin-top: 2.0em; |
| 139 | margin-bottom: 2.0em; |
| 140 | margin-right: 10%; |
| 141 | color: #606060; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | div.content { /* Block element content. */ |
| 145 | padding: 0; |
| 146 | } |
| 147 | |
| 148 | /* Block element titles. */ |
| 149 | div.title, caption.title { |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 150 | color: #527bbd; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 151 | font-weight: bold; |
| 152 | text-align: left; |
| 153 | margin-top: 1.0em; |
| 154 | margin-bottom: 0.5em; |
| 155 | } |
| 156 | div.title + * { |
| 157 | margin-top: 0; |
| 158 | } |
| 159 | |
| 160 | td div.title:first-child { |
| 161 | margin-top: 0.0em; |
| 162 | } |
| 163 | div.content div.title:first-child { |
| 164 | margin-top: 0.0em; |
| 165 | } |
| 166 | div.content + div.title { |
| 167 | margin-top: 0.0em; |
| 168 | } |
| 169 | |
| 170 | div.sidebarblock > div.content { |
| 171 | background: #ffffee; |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 172 | border: 1px solid #dddddd; |
| 173 | border-left: 4px solid #f0f0f0; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 174 | padding: 0.5em; |
| 175 | } |
| 176 | |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 177 | div.listingblock > div.content { |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 178 | border: 1px solid #dddddd; |
| 179 | border-left: 5px solid #f0f0f0; |
| 180 | background: #f8f8f8; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 181 | padding: 0.5em; |
| 182 | } |
| 183 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 184 | div.quoteblock, div.verseblock { |
| 185 | padding-left: 1.0em; |
| 186 | margin-left: 1.0em; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 187 | margin-right: 10%; |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 188 | border-left: 5px solid #f0f0f0; |
| 189 | color: #888; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 190 | } |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 191 | |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 192 | div.quoteblock > div.attribution { |
| 193 | padding-top: 0.5em; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 194 | text-align: right; |
| 195 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 196 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 197 | div.verseblock > pre.content { |
| 198 | font-family: inherit; |
| 199 | font-size: inherit; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 200 | } |
| 201 | div.verseblock > div.attribution { |
| 202 | padding-top: 0.75em; |
| 203 | text-align: left; |
| 204 | } |
| 205 | /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 206 | div.verseblock + div.attribution { |
| 207 | text-align: left; |
| 208 | } |
| 209 | |
| 210 | div.admonitionblock .icon { |
| 211 | vertical-align: top; |
| 212 | font-size: 1.1em; |
| 213 | font-weight: bold; |
| 214 | text-decoration: underline; |
| 215 | color: #527bbd; |
| 216 | padding-right: 0.5em; |
| 217 | } |
| 218 | div.admonitionblock td.content { |
| 219 | padding-left: 0.5em; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 220 | border-left: 3px solid #dddddd; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 221 | } |
| 222 | |
| 223 | div.exampleblock > div.content { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 224 | border-left: 3px solid #dddddd; |
| 225 | padding-left: 0.5em; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 226 | } |
| 227 | |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 228 | div.imageblock div.content { padding-left: 0; } |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 229 | span.image img { border-style: none; vertical-align: text-bottom; } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 230 | a.image:visited { color: white; } |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 231 | |
| 232 | dl { |
| 233 | margin-top: 0.8em; |
| 234 | margin-bottom: 0.8em; |
| 235 | } |
| 236 | dt { |
| 237 | margin-top: 0.5em; |
| 238 | margin-bottom: 0; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 239 | font-style: normal; |
| 240 | color: navy; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 241 | } |
| 242 | dd > *:first-child { |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 243 | margin-top: 0.1em; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 244 | } |
| 245 | |
| 246 | ul, ol { |
| 247 | list-style-position: outside; |
| 248 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 249 | ol.arabic { |
| 250 | list-style-type: decimal; |
| 251 | } |
| 252 | ol.loweralpha { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 253 | list-style-type: lower-alpha; |
| 254 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 255 | ol.upperalpha { |
| 256 | list-style-type: upper-alpha; |
| 257 | } |
| 258 | ol.lowerroman { |
| 259 | list-style-type: lower-roman; |
| 260 | } |
| 261 | ol.upperroman { |
| 262 | list-style-type: upper-roman; |
| 263 | } |
| 264 | |
| 265 | div.compact ul, div.compact ol, |
| 266 | div.compact p, div.compact p, |
| 267 | div.compact div, div.compact div { |
| 268 | margin-top: 0.1em; |
| 269 | margin-bottom: 0.1em; |
| 270 | } |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 271 | |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 272 | tfoot { |
| 273 | font-weight: bold; |
| 274 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 275 | td > div.verse { |
| 276 | white-space: pre; |
| 277 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 278 | |
| 279 | div.hdlist { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 280 | margin-top: 0.8em; |
| 281 | margin-bottom: 0.8em; |
| 282 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 283 | div.hdlist tr { |
| 284 | padding-bottom: 15px; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 285 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 286 | dt.hdlist1.strong, td.hdlist1.strong { |
| 287 | font-weight: bold; |
| 288 | } |
| 289 | td.hdlist1 { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 290 | vertical-align: top; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 291 | font-style: normal; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 292 | padding-right: 0.8em; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 293 | color: navy; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 294 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 295 | td.hdlist2 { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 296 | vertical-align: top; |
| 297 | } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 298 | div.hdlist.compact tr { |
| 299 | margin: 0; |
| 300 | padding-bottom: 0; |
| 301 | } |
| 302 | |
| 303 | .comment { |
| 304 | background: yellow; |
| 305 | } |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 306 | |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 307 | .footnote, .footnoteref { |
| 308 | font-size: 0.8em; |
| 309 | } |
| 310 | |
| 311 | span.footnote, span.footnoteref { |
| 312 | vertical-align: super; |
| 313 | } |
| 314 | |
| 315 | #footnotes { |
| 316 | margin: 20px 0 20px 0; |
| 317 | padding: 7px 0 0 0; |
| 318 | } |
| 319 | |
| 320 | #footnotes div.footnote { |
| 321 | margin: 0 0 5px 0; |
| 322 | } |
| 323 | |
| 324 | #footnotes hr { |
| 325 | border: none; |
| 326 | border-top: 1px solid silver; |
| 327 | height: 1px; |
| 328 | text-align: left; |
| 329 | margin-left: 0; |
| 330 | width: 20%; |
| 331 | min-width: 100px; |
| 332 | } |
| 333 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 334 | div.colist td { |
| 335 | padding-right: 0.5em; |
| 336 | padding-bottom: 0.3em; |
| 337 | vertical-align: top; |
| 338 | } |
| 339 | div.colist td img { |
| 340 | margin-top: 0.3em; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 341 | } |
| 342 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 343 | @media print { |
| 344 | #footer-badges { display: none; } |
| 345 | } |
| 346 | |
| 347 | #toc { |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 348 | margin-bottom: 2.5em; |
| 349 | } |
| 350 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 351 | #toctitle { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 352 | color: #527bbd; |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 353 | font-size: 1.1em; |
| 354 | font-weight: bold; |
| 355 | margin-top: 1.0em; |
| 356 | margin-bottom: 0.1em; |
| 357 | } |
| 358 | |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 359 | div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 360 | margin-top: 0; |
| 361 | margin-bottom: 0; |
| 362 | } |
| 363 | div.toclevel2 { |
| 364 | margin-left: 2em; |
| 365 | font-size: 0.9em; |
| 366 | } |
| 367 | div.toclevel3 { |
| 368 | margin-left: 4em; |
| 369 | font-size: 0.9em; |
| 370 | } |
| 371 | div.toclevel4 { |
| 372 | margin-left: 6em; |
| 373 | font-size: 0.9em; |
| 374 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 375 | |
| 376 | span.aqua { color: aqua; } |
| 377 | span.black { color: black; } |
| 378 | span.blue { color: blue; } |
| 379 | span.fuchsia { color: fuchsia; } |
| 380 | span.gray { color: gray; } |
| 381 | span.green { color: green; } |
| 382 | span.lime { color: lime; } |
| 383 | span.maroon { color: maroon; } |
| 384 | span.navy { color: navy; } |
| 385 | span.olive { color: olive; } |
| 386 | span.purple { color: purple; } |
| 387 | span.red { color: red; } |
| 388 | span.silver { color: silver; } |
| 389 | span.teal { color: teal; } |
| 390 | span.white { color: white; } |
| 391 | span.yellow { color: yellow; } |
| 392 | |
| 393 | span.aqua-background { background: aqua; } |
| 394 | span.black-background { background: black; } |
| 395 | span.blue-background { background: blue; } |
| 396 | span.fuchsia-background { background: fuchsia; } |
| 397 | span.gray-background { background: gray; } |
| 398 | span.green-background { background: green; } |
| 399 | span.lime-background { background: lime; } |
| 400 | span.maroon-background { background: maroon; } |
| 401 | span.navy-background { background: navy; } |
| 402 | span.olive-background { background: olive; } |
| 403 | span.purple-background { background: purple; } |
| 404 | span.red-background { background: red; } |
| 405 | span.silver-background { background: silver; } |
| 406 | span.teal-background { background: teal; } |
| 407 | span.white-background { background: white; } |
| 408 | span.yellow-background { background: yellow; } |
| 409 | |
| 410 | span.big { font-size: 2em; } |
| 411 | span.small { font-size: 0.6em; } |
| 412 | |
| 413 | span.underline { text-decoration: underline; } |
| 414 | span.overline { text-decoration: overline; } |
| 415 | span.line-through { text-decoration: line-through; } |
| 416 | |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 417 | div.unbreakable { page-break-inside: avoid; } |
| 418 | |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 419 | |
| 420 | /* |
| 421 | * xhtml11 specific |
| 422 | * |
| 423 | * */ |
| 424 | |
| 425 | div.tableblock { |
| 426 | margin-top: 1.0em; |
| 427 | margin-bottom: 1.5em; |
| 428 | } |
| 429 | div.tableblock > table { |
| 430 | border: 3px solid #527bbd; |
| 431 | } |
| 432 | thead, p.table.header { |
| 433 | font-weight: bold; |
| 434 | color: #527bbd; |
| 435 | } |
| 436 | p.table { |
| 437 | margin-top: 0; |
| 438 | } |
| 439 | /* Because the table frame attribute is overriden by CSS in most browsers. */ |
| 440 | div.tableblock > table[frame="void"] { |
| 441 | border-style: none; |
| 442 | } |
| 443 | div.tableblock > table[frame="hsides"] { |
| 444 | border-left-style: none; |
| 445 | border-right-style: none; |
| 446 | } |
| 447 | div.tableblock > table[frame="vsides"] { |
| 448 | border-top-style: none; |
| 449 | border-bottom-style: none; |
| 450 | } |
| 451 | |
| 452 | |
| 453 | /* |
| 454 | * html5 specific |
| 455 | * |
| 456 | * */ |
| 457 | |
| 458 | table.tableblock { |
| 459 | margin-top: 1.0em; |
| 460 | margin-bottom: 1.5em; |
| 461 | } |
| 462 | thead, p.tableblock.header { |
| 463 | font-weight: bold; |
| 464 | color: #527bbd; |
| 465 | } |
| 466 | p.tableblock { |
| 467 | margin-top: 0; |
| 468 | } |
| 469 | table.tableblock { |
| 470 | border-width: 3px; |
| 471 | border-spacing: 0px; |
| 472 | border-style: solid; |
| 473 | border-color: #527bbd; |
| 474 | border-collapse: collapse; |
| 475 | } |
| 476 | th.tableblock, td.tableblock { |
| 477 | border-width: 1px; |
| 478 | padding: 4px; |
| 479 | border-style: solid; |
| 480 | border-color: #527bbd; |
| 481 | } |
| 482 | |
| 483 | table.tableblock.frame-topbot { |
| 484 | border-left-style: hidden; |
| 485 | border-right-style: hidden; |
| 486 | } |
| 487 | table.tableblock.frame-sides { |
| 488 | border-top-style: hidden; |
| 489 | border-bottom-style: hidden; |
| 490 | } |
| 491 | table.tableblock.frame-none { |
| 492 | border-style: hidden; |
| 493 | } |
| 494 | |
| 495 | th.tableblock.halign-left, td.tableblock.halign-left { |
| 496 | text-align: left; |
| 497 | } |
| 498 | th.tableblock.halign-center, td.tableblock.halign-center { |
| 499 | text-align: center; |
| 500 | } |
| 501 | th.tableblock.halign-right, td.tableblock.halign-right { |
| 502 | text-align: right; |
| 503 | } |
| 504 | |
| 505 | th.tableblock.valign-top, td.tableblock.valign-top { |
| 506 | vertical-align: top; |
| 507 | } |
| 508 | th.tableblock.valign-middle, td.tableblock.valign-middle { |
| 509 | vertical-align: middle; |
| 510 | } |
| 511 | th.tableblock.valign-bottom, td.tableblock.valign-bottom { |
| 512 | vertical-align: bottom; |
| 513 | } |
| 514 | |
| 515 | |
| 516 | /* |
| 517 | * manpage specific |
| 518 | * |
| 519 | * */ |
| 520 | |
| 521 | body.manpage h1 { |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 522 | padding-top: 0.5em; |
| 523 | padding-bottom: 0.5em; |
| 524 | border-top: 2px solid silver; |
| 525 | border-bottom: 2px solid silver; |
| 526 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 527 | body.manpage h2 { |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 528 | border-style: none; |
| 529 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 530 | body.manpage div.sectionbody { |
| 531 | margin-left: 3em; |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 532 | } |
| 533 | |
| 534 | @media print { |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 535 | body.manpage div#toc { display: none; } |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 536 | } |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 537 | |
| 538 | |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 539 | </style> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 540 | <script type="text/javascript"> |
| 541 | /*<![CDATA[*/ |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 542 | var asciidoc = { // Namespace. |
| 543 | |
| 544 | ///////////////////////////////////////////////////////////////////// |
| 545 | // Table Of Contents generator |
| 546 | ///////////////////////////////////////////////////////////////////// |
| 547 | |
| 548 | /* Author: Mihai Bazon, September 2002 |
| 549 | * http://students.infoiasi.ro/~mishoo |
| 550 | * |
| 551 | * Table Of Content generator |
| 552 | * Version: 0.4 |
| 553 | * |
| 554 | * Feel free to use this script under the terms of the GNU General Public |
| 555 | * License, as long as you do not remove or alter this notice. |
| 556 | */ |
| 557 | |
| 558 | /* modified by Troy D. Hanson, September 2006. License: GPL */ |
| 559 | /* modified by Stuart Rackham, 2006, 2009. License: GPL */ |
| 560 | |
| 561 | // toclevels = 1..4. |
| 562 | toc: function (toclevels) { |
| 563 | |
| 564 | function getText(el) { |
| 565 | var text = ""; |
| 566 | for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 567 | if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants. |
| 568 | text += i.data; |
| 569 | else if (i.firstChild != null) |
| 570 | text += getText(i); |
| 571 | } |
| 572 | return text; |
| 573 | } |
| 574 | |
| 575 | function TocEntry(el, text, toclevel) { |
| 576 | this.element = el; |
| 577 | this.text = text; |
| 578 | this.toclevel = toclevel; |
| 579 | } |
| 580 | |
| 581 | function tocEntries(el, toclevels) { |
| 582 | var result = new Array; |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 583 | var re = new RegExp('[hH]([1-'+(toclevels+1)+'])'); |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 584 | // Function that scans the DOM tree for header elements (the DOM2 |
| 585 | // nodeIterator API would be a better technique but not supported by all |
| 586 | // browsers). |
| 587 | var iterate = function (el) { |
| 588 | for (var i = el.firstChild; i != null; i = i.nextSibling) { |
| 589 | if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { |
| 590 | var mo = re.exec(i.tagName); |
| 591 | if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { |
| 592 | result[result.length] = new TocEntry(i, getText(i), mo[1]-1); |
| 593 | } |
| 594 | iterate(i); |
| 595 | } |
| 596 | } |
| 597 | } |
| 598 | iterate(el); |
| 599 | return result; |
| 600 | } |
| 601 | |
| 602 | var toc = document.getElementById("toc"); |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 603 | if (!toc) { |
| 604 | return; |
| 605 | } |
| 606 | |
| 607 | // Delete existing TOC entries in case we're reloading the TOC. |
| 608 | var tocEntriesToRemove = []; |
| 609 | var i; |
| 610 | for (i = 0; i < toc.childNodes.length; i++) { |
| 611 | var entry = toc.childNodes[i]; |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 612 | if (entry.nodeName.toLowerCase() == 'div' |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 613 | && entry.getAttribute("class") |
| 614 | && entry.getAttribute("class").match(/^toclevel/)) |
| 615 | tocEntriesToRemove.push(entry); |
| 616 | } |
| 617 | for (i = 0; i < tocEntriesToRemove.length; i++) { |
| 618 | toc.removeChild(tocEntriesToRemove[i]); |
| 619 | } |
| 620 | |
| 621 | // Rebuild TOC entries. |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 622 | var entries = tocEntries(document.getElementById("content"), toclevels); |
| 623 | for (var i = 0; i < entries.length; ++i) { |
| 624 | var entry = entries[i]; |
| 625 | if (entry.element.id == "") |
| 626 | entry.element.id = "_toc_" + i; |
| 627 | var a = document.createElement("a"); |
| 628 | a.href = "#" + entry.element.id; |
| 629 | a.appendChild(document.createTextNode(entry.text)); |
| 630 | var div = document.createElement("div"); |
| 631 | div.appendChild(a); |
| 632 | div.className = "toclevel" + entry.toclevel; |
| 633 | toc.appendChild(div); |
| 634 | } |
| 635 | if (entries.length == 0) |
| 636 | toc.parentNode.removeChild(toc); |
| 637 | }, |
| 638 | |
| 639 | |
| 640 | ///////////////////////////////////////////////////////////////////// |
| 641 | // Footnotes generator |
| 642 | ///////////////////////////////////////////////////////////////////// |
| 643 | |
| 644 | /* Based on footnote generation code from: |
| 645 | * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html |
| 646 | */ |
| 647 | |
| 648 | footnotes: function () { |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 649 | // Delete existing footnote entries in case we're reloading the footnodes. |
| 650 | var i; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 651 | var noteholder = document.getElementById("footnotes"); |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 652 | if (!noteholder) { |
| 653 | return; |
| 654 | } |
| 655 | var entriesToRemove = []; |
| 656 | for (i = 0; i < noteholder.childNodes.length; i++) { |
| 657 | var entry = noteholder.childNodes[i]; |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 658 | if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 659 | entriesToRemove.push(entry); |
| 660 | } |
| 661 | for (i = 0; i < entriesToRemove.length; i++) { |
| 662 | noteholder.removeChild(entriesToRemove[i]); |
| 663 | } |
| 664 | |
| 665 | // Rebuild footnote entries. |
| 666 | var cont = document.getElementById("content"); |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 667 | var spans = cont.getElementsByTagName("span"); |
| 668 | var refs = {}; |
| 669 | var n = 0; |
| 670 | for (i=0; i<spans.length; i++) { |
| 671 | if (spans[i].className == "footnote") { |
| 672 | n++; |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 673 | var note = spans[i].getAttribute("data-note"); |
| 674 | if (!note) { |
| 675 | // Use [\s\S] in place of . so multi-line matches work. |
| 676 | // Because JavaScript has no s (dotall) regex flag. |
| 677 | note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; |
| 678 | spans[i].innerHTML = |
| 679 | "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + |
| 680 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 681 | spans[i].setAttribute("data-note", note); |
| 682 | } |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 683 | noteholder.innerHTML += |
| 684 | "<div class='footnote' id='_footnote_" + n + "'>" + |
| 685 | "<a href='#_footnoteref_" + n + "' title='Return to text'>" + |
| 686 | n + "</a>. " + note + "</div>"; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 687 | var id =spans[i].getAttribute("id"); |
| 688 | if (id != null) refs["#"+id] = n; |
| 689 | } |
| 690 | } |
| 691 | if (n == 0) |
| 692 | noteholder.parentNode.removeChild(noteholder); |
| 693 | else { |
| 694 | // Process footnoterefs. |
| 695 | for (i=0; i<spans.length; i++) { |
| 696 | if (spans[i].className == "footnoteref") { |
| 697 | var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); |
| 698 | href = href.match(/#.*/)[0]; // Because IE return full URL. |
| 699 | n = refs[href]; |
| 700 | spans[i].innerHTML = |
| 701 | "[<a href='#_footnote_" + n + |
| 702 | "' title='View footnote' class='footnote'>" + n + "</a>]"; |
| 703 | } |
| 704 | } |
| 705 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 706 | }, |
| 707 | |
| 708 | install: function(toclevels) { |
| 709 | var timerId; |
| 710 | |
| 711 | function reinstall() { |
| 712 | asciidoc.footnotes(); |
| 713 | if (toclevels) { |
| 714 | asciidoc.toc(toclevels); |
| 715 | } |
| 716 | } |
| 717 | |
| 718 | function reinstallAndRemoveTimer() { |
| 719 | clearInterval(timerId); |
| 720 | reinstall(); |
| 721 | } |
| 722 | |
| 723 | timerId = setInterval(reinstall, 500); |
| 724 | if (document.addEventListener) |
| 725 | document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); |
| 726 | else |
| 727 | window.onload = reinstallAndRemoveTimer; |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 728 | } |
| 729 | |
| 730 | } |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 731 | asciidoc.install(); |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 732 | /*]]>*/ |
| 733 | </script> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 734 | </head> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 735 | <body class="manpage"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 736 | <div id="header"> |
| 737 | <h1> |
| 738 | git-notes(1) Manual Page |
| 739 | </h1> |
| 740 | <h2>NAME</h2> |
| 741 | <div class="sectionbody"> |
| 742 | <p>git-notes - |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 743 | Add or inspect object notes |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 744 | </p> |
| 745 | </div> |
| 746 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 747 | <div id="content"> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 748 | <div class="sect1"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 749 | <h2 id="_synopsis">SYNOPSIS</h2> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 750 | <div class="sectionbody"> |
| 751 | <div class="verseblock"> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 752 | <pre class="content"><em>git notes</em> [list [<object>]] |
Junio C Hamano | fad8412 | 2014-12-05 23:38:06 | [diff] [blame] | 753 | <em>git notes</em> add [-f] [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>] |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 754 | <em>git notes</em> copy [-f] ( --stdin | <from-object> <to-object> ) |
Junio C Hamano | fad8412 | 2014-12-05 23:38:06 | [diff] [blame] | 755 | <em>git notes</em> append [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>] |
| 756 | <em>git notes</em> edit [--allow-empty] [<object>] |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 757 | <em>git notes</em> show [<object>] |
Junio C Hamano | d75148a | 2014-04-08 19:48:38 | [diff] [blame] | 758 | <em>git notes</em> merge [-v | -q] [-s <strategy> ] <notes-ref> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 759 | <em>git notes</em> merge --commit [-v | -q] |
| 760 | <em>git notes</em> merge --abort [-v | -q] |
Junio C Hamano | 084228c | 2011-05-30 08:13:52 | [diff] [blame] | 761 | <em>git notes</em> remove [--ignore-missing] [--stdin] [<object>…] |
Junio C Hamano | 912712b | 2017-12-06 18:04:01 | [diff] [blame] | 762 | <em>git notes</em> prune [-n] [-v] |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 763 | <em>git notes</em> get-ref</pre> |
| 764 | <div class="attribution"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 765 | </div></div> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 766 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 767 | </div> |
| 768 | <div class="sect1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 769 | <h2 id="_description">DESCRIPTION</h2> |
| 770 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 771 | <div class="paragraph"><p>Adds, removes, or reads notes attached to objects, without touching |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 772 | the objects themselves.</p></div> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 773 | <div class="paragraph"><p>By default, notes are saved to and read from <code>refs/notes/commits</code>, but |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 774 | this default can be overridden. See the OPTIONS, CONFIGURATION, and |
| 775 | ENVIRONMENT sections below. If this ref does not exist, it will be |
| 776 | quietly created when it is first needed to store a note.</p></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 777 | <div class="paragraph"><p>A typical use of notes is to supplement a commit message without |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 778 | changing the commit itself. Notes can be shown by <em>git log</em> along with |
| 779 | the original commit message. To distinguish these notes from the |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 780 | message stored in the commit object, the notes are indented like the |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 781 | message, after an unindented line saying "Notes (<refname>):" (or |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 782 | "Notes:" for <code>refs/notes/commits</code>).</p></div> |
| 783 | <div class="paragraph"><p>Notes can also be added to patches prepared with <code>git format-patch</code> by |
| 784 | using the <code>--notes</code> option. Such notes are added as a patch commentary |
Junio C Hamano | 4eb2b9c | 2012-11-15 21:12:29 | [diff] [blame] | 785 | after a three dash separator line.</p></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 786 | <div class="paragraph"><p>To change which notes are shown by <em>git log</em>, see the |
Junio C Hamano | a28a920 | 2012-06-21 07:08:23 | [diff] [blame] | 787 | "notes.displayRef" configuration in <a href="git-log.html">git-log(1)</a>.</p></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 788 | <div class="paragraph"><p>See the "notes.rewrite.<command>" configuration for a way to carry |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 789 | notes across commands that rewrite commits.</p></div> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 790 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 791 | </div> |
| 792 | <div class="sect1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 793 | <h2 id="_subcommands">SUBCOMMANDS</h2> |
| 794 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 795 | <div class="dlist"><dl> |
| 796 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 797 | list |
| 798 | </dt> |
| 799 | <dd> |
| 800 | <p> |
| 801 | List the notes object for a given object. If no object is |
| 802 | given, show a list of all note objects and the objects they |
| 803 | annotate (in the format "<note object> <annotated object>"). |
| 804 | This is the default subcommand if no subcommand is given. |
| 805 | </p> |
| 806 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 807 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 808 | add |
| 809 | </dt> |
| 810 | <dd> |
| 811 | <p> |
| 812 | Add notes for a given object (defaults to HEAD). Abort if the |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 813 | object already has notes (use <code>-f</code> to overwrite existing notes). |
| 814 | However, if you’re using <code>add</code> interactively (using an editor |
Junio C Hamano | 6003346 | 2011-05-03 00:48:43 | [diff] [blame] | 815 | to supply the notes contents), then - instead of aborting - |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 816 | the existing notes will be opened in the editor (like the <code>edit</code> |
Junio C Hamano | 6003346 | 2011-05-03 00:48:43 | [diff] [blame] | 817 | subcommand). |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 818 | </p> |
| 819 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 820 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 821 | copy |
| 822 | </dt> |
| 823 | <dd> |
| 824 | <p> |
| 825 | Copy the notes for the first object onto the second object. |
| 826 | Abort if the second object already has notes, or if the first |
| 827 | object has none (use -f to overwrite existing notes to the |
| 828 | second object). This subcommand is equivalent to: |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 829 | <code>git notes add [-f] -C $(git notes list <from-object>) <to-object></code> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 830 | </p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 831 | <div class="paragraph"><p>In <code>--stdin</code> mode, take lines in the format</p></div> |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 832 | <div class="listingblock"> |
| 833 | <div class="content"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 834 | <pre><code><from-object> SP <to-object> [ SP <rest> ] LF</code></pre> |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 835 | </div></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 836 | <div class="paragraph"><p>on standard input, and copy the notes from each <from-object> to its |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 837 | corresponding <to-object>. (The optional <code><rest></code> is ignored so that |
| 838 | the command can read the input given to the <code>post-rewrite</code> hook.)</p></div> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 839 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 840 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 841 | append |
| 842 | </dt> |
| 843 | <dd> |
| 844 | <p> |
| 845 | Append to the notes of an existing object (defaults to HEAD). |
| 846 | Creates a new notes object if needed. |
| 847 | </p> |
| 848 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 849 | <dt class="hdlist1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 850 | edit |
| 851 | </dt> |
| 852 | <dd> |
| 853 | <p> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 854 | Edit the notes for a given object (defaults to HEAD). |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 855 | </p> |
| 856 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 857 | <dt class="hdlist1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 858 | show |
| 859 | </dt> |
| 860 | <dd> |
| 861 | <p> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 862 | Show the notes for a given object (defaults to HEAD). |
| 863 | </p> |
| 864 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 865 | <dt class="hdlist1"> |
| 866 | merge |
| 867 | </dt> |
| 868 | <dd> |
| 869 | <p> |
| 870 | Merge the given notes ref into the current notes ref. |
| 871 | This will try to merge the changes made by the given |
| 872 | notes ref (called "remote") since the merge-base (if |
| 873 | any) into the current notes ref (called "local"). |
| 874 | </p> |
| 875 | <div class="paragraph"><p>If conflicts arise and a strategy for automatically resolving |
Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 876 | conflicting notes (see the "NOTES MERGE STRATEGIES" section) is not given, |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 877 | the "manual" resolver is used. This resolver checks out the |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 878 | conflicting notes in a special worktree (<code>.git/NOTES_MERGE_WORKTREE</code>), |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 879 | and instructs the user to manually resolve the conflicts there. |
| 880 | When done, the user can either finalize the merge with |
| 881 | <em>git notes merge --commit</em>, or abort the merge with |
| 882 | <em>git notes merge --abort</em>.</p></div> |
| 883 | </dd> |
| 884 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 885 | remove |
| 886 | </dt> |
| 887 | <dd> |
| 888 | <p> |
Junio C Hamano | 084228c | 2011-05-30 08:13:52 | [diff] [blame] | 889 | Remove the notes for given objects (defaults to HEAD). When |
| 890 | giving zero or one object from the command line, this is |
| 891 | equivalent to specifying an empty note message to |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 892 | the <code>edit</code> subcommand. |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 893 | </p> |
| 894 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 895 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 896 | prune |
| 897 | </dt> |
| 898 | <dd> |
| 899 | <p> |
| 900 | Remove all notes for non-existing/unreachable objects. |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 901 | </p> |
| 902 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 903 | <dt class="hdlist1"> |
| 904 | get-ref |
| 905 | </dt> |
| 906 | <dd> |
| 907 | <p> |
| 908 | Print the current notes ref. This provides an easy way to |
| 909 | retrieve the current notes ref (e.g. from scripts). |
| 910 | </p> |
| 911 | </dd> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 912 | </dl></div> |
| 913 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 914 | </div> |
| 915 | <div class="sect1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 916 | <h2 id="_options">OPTIONS</h2> |
| 917 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 918 | <div class="dlist"><dl> |
| 919 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 920 | -f |
| 921 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 922 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 923 | --force |
| 924 | </dt> |
| 925 | <dd> |
| 926 | <p> |
| 927 | When adding notes to an object that already has notes, |
| 928 | overwrite the existing notes (instead of aborting). |
| 929 | </p> |
| 930 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 931 | <dt class="hdlist1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 932 | -m <msg> |
| 933 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 934 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 935 | --message=<msg> |
| 936 | </dt> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 937 | <dd> |
| 938 | <p> |
| 939 | Use the given note message (instead of prompting). |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 940 | If multiple <code>-m</code> options are given, their values |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 941 | are concatenated as separate paragraphs. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 942 | Lines starting with <code>#</code> and empty lines other than a |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 943 | single line between paragraphs will be stripped out. |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 944 | </p> |
| 945 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 946 | <dt class="hdlist1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 947 | -F <file> |
| 948 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 949 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 950 | --file=<file> |
| 951 | </dt> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 952 | <dd> |
| 953 | <p> |
| 954 | Take the note message from the given file. Use <em>-</em> to |
| 955 | read the note message from the standard input. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 956 | Lines starting with <code>#</code> and empty lines other than a |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 957 | single line between paragraphs will be stripped out. |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 958 | </p> |
| 959 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 960 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 961 | -C <object> |
| 962 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 963 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 964 | --reuse-message=<object> |
| 965 | </dt> |
| 966 | <dd> |
| 967 | <p> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 968 | Take the given blob object (for example, another note) as the |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 969 | note message. (Use <code>git notes copy <object></code> instead to |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 970 | copy notes between objects.) |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 971 | </p> |
| 972 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 973 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 974 | -c <object> |
| 975 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 976 | <dt class="hdlist1"> |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 977 | --reedit-message=<object> |
| 978 | </dt> |
| 979 | <dd> |
| 980 | <p> |
Junio C Hamano | 92d8037 | 2016-07-13 22:00:05 | [diff] [blame] | 981 | Like <em>-C</em>, but with <code>-c</code> the editor is invoked, so that |
Junio C Hamano | ea90ab3 | 2010-03-15 20:32:55 | [diff] [blame] | 982 | the user can further edit the note message. |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 983 | </p> |
| 984 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 985 | <dt class="hdlist1"> |
Junio C Hamano | fad8412 | 2014-12-05 23:38:06 | [diff] [blame] | 986 | --allow-empty |
| 987 | </dt> |
| 988 | <dd> |
| 989 | <p> |
| 990 | Allow an empty note object to be stored. The default behavior is |
| 991 | to automatically remove empty notes. |
| 992 | </p> |
| 993 | </dd> |
| 994 | <dt class="hdlist1"> |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 995 | --ref <ref> |
| 996 | </dt> |
| 997 | <dd> |
| 998 | <p> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 999 | Manipulate the notes tree in <ref>. This overrides |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1000 | <code>GIT_NOTES_REF</code> and the "core.notesRef" configuration. The ref |
Junio C Hamano | 1f7c4a5 | 2015-10-14 22:15:51 | [diff] [blame] | 1001 | specifies the full refname when it begins with <code>refs/notes/</code>; when it |
| 1002 | begins with <code>notes/</code>, <code>refs/</code> and otherwise <code>refs/notes/</code> is prefixed |
| 1003 | to form a full name of the ref. |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1004 | </p> |
| 1005 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1006 | <dt class="hdlist1"> |
Junio C Hamano | 084228c | 2011-05-30 08:13:52 | [diff] [blame] | 1007 | --ignore-missing |
| 1008 | </dt> |
| 1009 | <dd> |
| 1010 | <p> |
| 1011 | Do not consider it an error to request removing notes from an |
| 1012 | object that does not have notes attached to it. |
| 1013 | </p> |
| 1014 | </dd> |
| 1015 | <dt class="hdlist1"> |
| 1016 | --stdin |
| 1017 | </dt> |
| 1018 | <dd> |
| 1019 | <p> |
Junio C Hamano | d4bbec0 | 2017-09-25 07:24:53 | [diff] [blame] | 1020 | Also read the object names to remove notes from the standard |
Junio C Hamano | 084228c | 2011-05-30 08:13:52 | [diff] [blame] | 1021 | input (there is no reason you cannot combine this with object |
| 1022 | names from the command line). |
| 1023 | </p> |
| 1024 | </dd> |
| 1025 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1026 | -n |
| 1027 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1028 | <dt class="hdlist1"> |
Junio C Hamano | e85e36f | 2010-08-10 05:30:14 | [diff] [blame] | 1029 | --dry-run |
| 1030 | </dt> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1031 | <dd> |
| 1032 | <p> |
| 1033 | Do not remove anything; just report the object names whose notes |
| 1034 | would be removed. |
| 1035 | </p> |
| 1036 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1037 | <dt class="hdlist1"> |
| 1038 | -s <strategy> |
| 1039 | </dt> |
| 1040 | <dt class="hdlist1"> |
| 1041 | --strategy=<strategy> |
| 1042 | </dt> |
| 1043 | <dd> |
| 1044 | <p> |
| 1045 | When merging notes, resolve notes conflicts using the given |
| 1046 | strategy. The following strategies are recognized: "manual" |
| 1047 | (default), "ours", "theirs", "union" and "cat_sort_uniq". |
Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 1048 | This option overrides the "notes.mergeStrategy" configuration setting. |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1049 | See the "NOTES MERGE STRATEGIES" section below for more |
| 1050 | information on each notes merge strategy. |
| 1051 | </p> |
| 1052 | </dd> |
| 1053 | <dt class="hdlist1"> |
| 1054 | --commit |
| 1055 | </dt> |
| 1056 | <dd> |
| 1057 | <p> |
| 1058 | Finalize an in-progress <em>git notes merge</em>. Use this option |
| 1059 | when you have resolved the conflicts that <em>git notes merge</em> |
| 1060 | stored in .git/NOTES_MERGE_WORKTREE. This amends the partial |
| 1061 | merge commit created by <em>git notes merge</em> (stored in |
| 1062 | .git/NOTES_MERGE_PARTIAL) by adding the notes in |
| 1063 | .git/NOTES_MERGE_WORKTREE. The notes ref stored in the |
| 1064 | .git/NOTES_MERGE_REF symref is updated to the resulting commit. |
| 1065 | </p> |
| 1066 | </dd> |
| 1067 | <dt class="hdlist1"> |
| 1068 | --abort |
| 1069 | </dt> |
| 1070 | <dd> |
| 1071 | <p> |
Junio C Hamano | ea1ac8d | 2018-07-18 20:16:48 | [diff] [blame] | 1072 | Abort/reset an in-progress <em>git notes merge</em>, i.e. a notes merge |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1073 | with conflicts. This simply removes all files related to the |
| 1074 | notes merge. |
| 1075 | </p> |
| 1076 | </dd> |
| 1077 | <dt class="hdlist1"> |
| 1078 | -q |
| 1079 | </dt> |
| 1080 | <dt class="hdlist1"> |
| 1081 | --quiet |
| 1082 | </dt> |
| 1083 | <dd> |
| 1084 | <p> |
| 1085 | When merging notes, operate quietly. |
| 1086 | </p> |
| 1087 | </dd> |
| 1088 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1089 | -v |
| 1090 | </dt> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1091 | <dt class="hdlist1"> |
Junio C Hamano | e85e36f | 2010-08-10 05:30:14 | [diff] [blame] | 1092 | --verbose |
| 1093 | </dt> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1094 | <dd> |
| 1095 | <p> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1096 | When merging notes, be more verbose. |
| 1097 | When pruning notes, report all object names whose notes are |
| 1098 | removed. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1099 | </p> |
| 1100 | </dd> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 1101 | </dl></div> |
| 1102 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1103 | </div> |
| 1104 | <div class="sect1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1105 | <h2 id="_discussion">DISCUSSION</h2> |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1106 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1107 | <div class="paragraph"><p>Commit notes are blobs containing extra information about an object |
| 1108 | (usually information to supplement a commit’s message). These blobs |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1109 | are taken from notes refs. A notes ref is usually a branch which |
| 1110 | contains "files" whose paths are the object names for the objects |
| 1111 | they describe, with some directory separators included for performance |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1112 | reasons <span class="footnote"><br />[Permitted pathnames have the form |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1113 | <em>ab</em><code>/</code><em>cd</em><code>/</code><em>ef</em><code>/</code><em>…</em><code>/</code><em>abcdef…</em>: a sequence of directory |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1114 | names of two hexadecimal digits each followed by a filename with the |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1115 | rest of the object ID.]<br /></span>.</p></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1116 | <div class="paragraph"><p>Every notes change creates a new commit at the specified notes ref. |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1117 | You can therefore inspect the history of the notes by invoking, e.g., |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1118 | <code>git log -p notes/commits</code>. Currently the commit message only records |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1119 | which operation triggered the update, and the commit authorship is |
Junio C Hamano | a28a920 | 2012-06-21 07:08:23 | [diff] [blame] | 1120 | determined according to the usual rules (see <a href="git-commit.html">git-commit(1)</a>). |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1121 | These details may change in the future.</p></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1122 | <div class="paragraph"><p>It is also permitted for a notes ref to point directly to a tree |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1123 | object, in which case the history of the notes can be read with |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1124 | <code>git log -p -g <refname></code>.</p></div> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1125 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1126 | </div> |
| 1127 | <div class="sect1"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1128 | <h2 id="_notes_merge_strategies">NOTES MERGE STRATEGIES</h2> |
| 1129 | <div class="sectionbody"> |
| 1130 | <div class="paragraph"><p>The default notes merge strategy is "manual", which checks out |
| 1131 | conflicting notes in a special work tree for resolving notes conflicts |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1132 | (<code>.git/NOTES_MERGE_WORKTREE</code>), and instructs the user to resolve the |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1133 | conflicts in that work tree. |
| 1134 | When done, the user can either finalize the merge with |
| 1135 | <em>git notes merge --commit</em>, or abort the merge with |
| 1136 | <em>git notes merge --abort</em>.</p></div> |
Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 1137 | <div class="paragraph"><p>Users may select an automated merge strategy from among the following using |
| 1138 | either -s/--strategy option or configuring notes.mergeStrategy accordingly:</p></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1139 | <div class="paragraph"><p>"ours" automatically resolves conflicting notes in favor of the local |
| 1140 | version (i.e. the current notes ref).</p></div> |
| 1141 | <div class="paragraph"><p>"theirs" automatically resolves notes conflicts in favor of the remote |
| 1142 | version (i.e. the given notes ref being merged into the current notes |
| 1143 | ref).</p></div> |
| 1144 | <div class="paragraph"><p>"union" automatically resolves notes conflicts by concatenating the |
| 1145 | local and remote versions.</p></div> |
| 1146 | <div class="paragraph"><p>"cat_sort_uniq" is similar to "union", but in addition to concatenating |
| 1147 | the local and remote versions, this strategy also sorts the resulting |
| 1148 | lines, and removes duplicate lines from the result. This is equivalent |
| 1149 | to applying the "cat | sort | uniq" shell pipeline to the local and |
| 1150 | remote versions. This strategy is useful if the notes follow a line-based |
| 1151 | format where one wants to avoid duplicated lines in the merge result. |
| 1152 | Note that if either the local or remote version contain duplicate lines |
| 1153 | prior to the merge, these will also be removed by this notes merge |
| 1154 | strategy.</p></div> |
| 1155 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1156 | </div> |
| 1157 | <div class="sect1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1158 | <h2 id="_examples">EXAMPLES</h2> |
| 1159 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1160 | <div class="paragraph"><p>You can use notes to add annotations with information that was not |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1161 | available at the time a commit was written.</p></div> |
| 1162 | <div class="listingblock"> |
| 1163 | <div class="content"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1164 | <pre><code>$ git notes add -m 'Tested-by: Johannes Sixt <j6t@kdbg.org>' 72a144e2 |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1165 | $ git show -s 72a144e |
| 1166 | [...] |
| 1167 | Signed-off-by: Junio C Hamano <gitster@pobox.com> |
| 1168 | |
| 1169 | Notes: |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1170 | Tested-by: Johannes Sixt <j6t@kdbg.org></code></pre> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1171 | </div></div> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1172 | <div class="paragraph"><p>In principle, a note is a regular Git blob, and any kind of |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1173 | (non-)format is accepted. You can binary-safely create notes from |
| 1174 | arbitrary files using <em>git hash-object</em>:</p></div> |
| 1175 | <div class="listingblock"> |
| 1176 | <div class="content"> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1177 | <pre><code>$ cc *.c |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1178 | $ blob=$(git hash-object -w a.out) |
Junio C Hamano | fad8412 | 2014-12-05 23:38:06 | [diff] [blame] | 1179 | $ git notes --ref=built add --allow-empty -C "$blob" HEAD</code></pre> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1180 | </div></div> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1181 | <div class="paragraph"><p>(You cannot simply use <code>git notes --ref=built add -F a.out HEAD</code> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1182 | because that is not binary-safe.) |
| 1183 | Of course, it doesn’t make much sense to display non-text-format notes |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1184 | with <em>git log</em>, so if you use such notes, you’ll probably need to write |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1185 | some special-purpose tools to do something useful with them.</p></div> |
| 1186 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1187 | </div> |
| 1188 | <div class="sect1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1189 | <h2 id="_configuration">CONFIGURATION</h2> |
| 1190 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1191 | <div class="dlist"><dl> |
| 1192 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1193 | core.notesRef |
| 1194 | </dt> |
| 1195 | <dd> |
| 1196 | <p> |
| 1197 | Notes ref to read and manipulate instead of |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1198 | <code>refs/notes/commits</code>. Must be an unabbreviated ref name. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1199 | This setting can be overridden through the environment and |
| 1200 | command line. |
| 1201 | </p> |
| 1202 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1203 | <dt class="hdlist1"> |
Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 1204 | notes.mergeStrategy |
| 1205 | </dt> |
| 1206 | <dd> |
| 1207 | <p> |
| 1208 | Which merge strategy to choose by default when resolving notes |
| 1209 | conflicts. Must be one of <code>manual</code>, <code>ours</code>, <code>theirs</code>, <code>union</code>, or |
| 1210 | <code>cat_sort_uniq</code>. Defaults to <code>manual</code>. See "NOTES MERGE STRATEGIES" |
| 1211 | section above for more information on each strategy. |
| 1212 | </p> |
| 1213 | <div class="paragraph"><p>This setting can be overridden by passing the <code>--strategy</code> option.</p></div> |
| 1214 | </dd> |
| 1215 | <dt class="hdlist1"> |
| 1216 | notes.<name>.mergeStrategy |
| 1217 | </dt> |
| 1218 | <dd> |
| 1219 | <p> |
| 1220 | Which merge strategy to choose when doing a notes merge into |
| 1221 | refs/notes/<name>. This overrides the more general |
| 1222 | "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section above |
| 1223 | for more information on each available strategy. |
| 1224 | </p> |
| 1225 | </dd> |
| 1226 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1227 | notes.displayRef |
| 1228 | </dt> |
| 1229 | <dd> |
| 1230 | <p> |
| 1231 | Which ref (or refs, if a glob or specified more than once), in |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1232 | addition to the default set by <code>core.notesRef</code> or |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1233 | <code>GIT_NOTES_REF</code>, to read notes from when showing commit |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1234 | messages with the <em>git log</em> family of commands. |
| 1235 | This setting can be overridden on the command line or by the |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1236 | <code>GIT_NOTES_DISPLAY_REF</code> environment variable. |
Junio C Hamano | a28a920 | 2012-06-21 07:08:23 | [diff] [blame] | 1237 | See <a href="git-log.html">git-log(1)</a>. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1238 | </p> |
| 1239 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1240 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1241 | notes.rewrite.<command> |
| 1242 | </dt> |
| 1243 | <dd> |
| 1244 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1245 | When rewriting commits with <command> (currently <code>amend</code> or |
| 1246 | <code>rebase</code>), if this variable is <code>false</code>, git will not copy |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1247 | notes from the original to the rewritten commit. Defaults to |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1248 | <code>true</code>. See also "<code>notes.rewriteRef</code>" below. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1249 | </p> |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1250 | <div class="paragraph"><p>This setting can be overridden by the <code>GIT_NOTES_REWRITE_REF</code> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1251 | environment variable.</p></div> |
| 1252 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1253 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1254 | notes.rewriteMode |
| 1255 | </dt> |
| 1256 | <dd> |
| 1257 | <p> |
| 1258 | When copying notes during a rewrite, what to do if the target |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1259 | commit already has a note. Must be one of <code>overwrite</code>, |
Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 1260 | <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>. Defaults to |
| 1261 | <code>concatenate</code>. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1262 | </p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1263 | <div class="paragraph"><p>This setting can be overridden with the <code>GIT_NOTES_REWRITE_MODE</code> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1264 | environment variable.</p></div> |
| 1265 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1266 | <dt class="hdlist1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1267 | notes.rewriteRef |
| 1268 | </dt> |
| 1269 | <dd> |
| 1270 | <p> |
| 1271 | When copying notes during a rewrite, specifies the (fully |
| 1272 | qualified) ref whose notes should be copied. May be a glob, |
| 1273 | in which case notes in all matching refs will be copied. You |
| 1274 | may also specify this configuration several times. |
| 1275 | </p> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1276 | <div class="paragraph"><p>Does not have a default value; you must configure this variable to |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1277 | enable note rewriting.</p></div> |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1278 | <div class="paragraph"><p>Can be overridden with the <code>GIT_NOTES_REWRITE_REF</code> environment variable.</p></div> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1279 | </dd> |
| 1280 | </dl></div> |
| 1281 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1282 | </div> |
| 1283 | <div class="sect1"> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1284 | <h2 id="_environment">ENVIRONMENT</h2> |
| 1285 | <div class="sectionbody"> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1286 | <div class="dlist"><dl> |
| 1287 | <dt class="hdlist1"> |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1288 | <code>GIT_NOTES_REF</code> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1289 | </dt> |
| 1290 | <dd> |
| 1291 | <p> |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1292 | Which ref to manipulate notes from, instead of <code>refs/notes/commits</code>. |
| 1293 | This overrides the <code>core.notesRef</code> setting. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1294 | </p> |
| 1295 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1296 | <dt class="hdlist1"> |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1297 | <code>GIT_NOTES_DISPLAY_REF</code> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1298 | </dt> |
| 1299 | <dd> |
| 1300 | <p> |
| 1301 | Colon-delimited list of refs or globs indicating which refs, |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1302 | in addition to the default from <code>core.notesRef</code> or |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1303 | <code>GIT_NOTES_REF</code>, to read notes from when showing commit |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1304 | messages. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1305 | This overrides the <code>notes.displayRef</code> setting. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1306 | </p> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1307 | <div class="paragraph"><p>A warning will be issued for refs that do not exist, but a glob that |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1308 | does not match any refs is silently ignored.</p></div> |
| 1309 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1310 | <dt class="hdlist1"> |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1311 | <code>GIT_NOTES_REWRITE_MODE</code> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1312 | </dt> |
| 1313 | <dd> |
| 1314 | <p> |
| 1315 | When copying notes during a rewrite, what to do if the target |
| 1316 | commit already has a note. |
Junio C Hamano | 3891e25 | 2015-08-31 23:06:13 | [diff] [blame] | 1317 | Must be one of <code>overwrite</code>, <code>concatenate</code>, <code>cat_sort_uniq</code>, or <code>ignore</code>. |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1318 | This overrides the <code>core.rewriteMode</code> setting. |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1319 | </p> |
| 1320 | </dd> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1321 | <dt class="hdlist1"> |
Junio C Hamano | 042f214 | 2016-06-27 18:05:05 | [diff] [blame] | 1322 | <code>GIT_NOTES_REWRITE_REF</code> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1323 | </dt> |
| 1324 | <dd> |
| 1325 | <p> |
| 1326 | When rewriting commits, which notes to copy from the original |
| 1327 | to the rewritten commit. Must be a colon-delimited list of |
| 1328 | refs or globs. |
| 1329 | </p> |
Junio C Hamano | 788eeba | 2010-12-08 22:50:43 | [diff] [blame] | 1330 | <div class="paragraph"><p>If not set in the environment, the list of notes to copy depends |
Junio C Hamano | c14e6ad | 2014-10-31 20:25:53 | [diff] [blame] | 1331 | on the <code>notes.rewrite.<command></code> and <code>notes.rewriteRef</code> settings.</p></div> |
Junio C Hamano | a574a09 | 2010-06-13 19:57:10 | [diff] [blame] | 1332 | </dd> |
| 1333 | </dl></div> |
Junio C Hamano | 3166736 | 2010-03-25 00:38:53 | [diff] [blame] | 1334 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1335 | </div> |
| 1336 | <div class="sect1"> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 1337 | <h2 id="_git">GIT</h2> |
| 1338 | <div class="sectionbody"> |
Junio C Hamano | 198b1f1 | 2016-05-17 22:27:24 | [diff] [blame] | 1339 | <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 1340 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1341 | </div> |
Junio C Hamano | 9d97115 | 2012-12-19 00:43:11 | [diff] [blame] | 1342 | </div> |
Junio C Hamano | 7bd050f | 2011-09-22 06:32:22 | [diff] [blame] | 1343 | <div id="footnotes"><hr /></div> |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 1344 | <div id="footer"> |
| 1345 | <div id="footer-text"> |
Junio C Hamano | 2ef0ba3 | 2018-01-26 23:13:53 | [diff] [blame] | 1346 | Last updated |
Junio C Hamano | c01eecf | 2019-05-30 18:17:47 | [diff] [blame] | 1347 | 2019-04-16 05:48:13 PDT |
Junio C Hamano | 3b70d3c | 2009-11-21 17:37:37 | [diff] [blame] | 1348 | </div> |
| 1349 | </div> |
| 1350 | </body> |
| 1351 | </html> |