graph: uncomment is_boundary propagation
[tig.git] / NEWS.adoc
blob81ca8e1ee7e6467aec89b5c79fa5909e9360349d
1 Release notes
2 =============
4 master
5 ------
7 Note to packagers:
9  - Rename README, INSTALL, and NEWS to end in '.adoc'.
10  - BUGS file has been merged into README.
11  - Rename (again) doc/ AsciiDoc files to end in '.adoc'.
13 Improvements:
15  - Add 'stage-split-chunk' action for splitting chunks in the stage view.
16    Bound to '\' by default. (GH #107)
17  - Add 'back' action bound to '<' by default, which will return the blame view
18    to the previous revision and line after moving e.g. to the parent. (GH #124)
19  - User-defined commands no longer needs to always be prefixed with '!'.
20  - Add auto-configuration for Cygwin (OS name: CYGWIN_NT-6.1). (GH #92)
21  - Add toggling for display files of untracked directories.
22  - Add main view pager mode that reads git-log's '--pretty=raw' data
23    from stdin, e.g. `git reflog --pretty=raw | tig --pretty=raw`.
24  - Document the Git commands supported by the pager mode.  (GH #1)
26 Bug fixes:
28  - Fix stash diff display when reloading the stash view after a deleting.
29  - Set the commit reference when opening the blame view from the blob view.
30  - Correctly identify and highlight the remote branch tracked by HEAD.
31  - Pass --no-color after user defined arguments to ensure that colors do not
32    break the output parsing. (GH #191)
33  - Close stdin when pager mode is not supported.
34  - Show newly created branches in the main view. (GH #196)
36 tig-1.2.1
37 ---------
39 Incompatibilities:
41  - Move manual and man pages to doc/ directory and rename AsciiDoc files
42    to have .asciidoc as the extension to make them render on GitHub.
44 Improvements:
46  - Show blob sizes in the tree view either as bytes or using binary unit
47    prefixes. Example: `set show-file-size = units`. (GH #163)
48  - Reduce main view memory usage and startup time, especially when revision
49    graph rendering is disabled. (GH #160)
51 Bug fixes:
53  - Fix submodule-related setup to check for non-zero return value from
54    setenv(). (GH #188)
56 tig-1.2
57 -------
59  - Tig now has its own tag on Stack Overflow, where users are invited to
60    ask questions: http://stackoverflow.com/questions/tagged/tig
62 Improvements:
64  - Prompt commands can be bound to keys. For example:
65    `bind diff F :set diff-options = --full-diff`. (GH #69, #116)
66  - Add a diff-options setting for specifying default diff options.
67    Example: `set diff-options = --patience`. (GH #116)
68  - Options in diff-options and blame-options matching Tig browsing state
69    variables are replaced.
70  - Show diff stats as wide as the terminal. (GH #109)
71  - Show line numbers in the branch view. (GH #135)
72  - Add toggles for showing author email or email user names. (GH #115)
73  - Open editor at the selected line by prefixing the file argument with
74    `+<lineno>`. Tested in vi, Vim, Emacs, Nano, Gedit, Geany. Disable
75    by adding `set editor-line-number = no` to ~/.tigrc. (GH #118, #119)
76  - Add toggle-files to control whether to show full commit diff or only
77    the diff concerning the currently selected file, e.g. for blame.
78  - Optionally highlight exceeding characters in long commit titles.
79    The default title max width is 50 characters. Customize using:
80    `set title-overflow = 50` (GH #125)
81  - Add +ESC key bindings. Example: `bind generic ^[v move-page-up` (GH #120)
82  - Create temporary files in TMPDIR, TEMP, or TMP before defaulting to /tmp.
83  - Reenable `tig log` as a subcommand. (GH #146)
84  - Enable tilde expansion in ~/.tigrc "source" commands. (GH #168)
85  - Introduce the stash view, bound to the 'y' keybinding. (GH #169, #174)
87 Bug fixes:
89  - Fix blame and status to work in directories starting with a dot. (GH #172)
90  - Reload current branch name when reloading the status view. (GH #93)
91  - Fix compile errors on old Solaris. (GH #97)
92  - Reload HEAD info when reloading the stage view. (GH #104, #93)
93  - Fix disappearing branch labels after external commands. (GH #148)
94  - Fix diff view display for staged/unstaged changes when using 'd'.
95  - Fix display of status messages when toggling view options. (GH #111)
96  - Fix illegal memory access. (GH #98)
97  - Fix display of all branches label in repos with short branch names.
98  - Fix rendering glitch for branch names.
99  - Do not apply diff styling to untracked files in the stage view. (GH #153)
100  - Fix tree indentation for entries containing combining characters. (GH #170)
101  - Ignore unrepresentable characters when transliterating text for rendering.
102  - Transliterate text to output encoding before trimming it to avoid
103    misalignment. (GH #86)
104  - Introduce a more natural context-sensitive log display. (GH #155)
106 tig-1.1
107 -------
109 Incompatibilities:
111  - Disable diff move/copy detection by default, boosting diff
112    performance on larger projects. Use git config 'diff.renames' option
113    (Git-wide) to set your preferred behavior. Environment variable
114    TIG_DIFF_OPTS can be used to restore the old behavior.
115  - Fix manual keybinding for stage-single-line. (GH #108)
116  - Values set for author-width and filename-width will result in widths
117    one character bigger than previously.
119 Improvements:
121  - Typing a text in the prompt will be interpreted as a Tig command.
122    Prefixing the command with a '!' will execute this system command in
123    an external pager. Entering a single key will execute the
124    corresponding key binding.
125  - Basic support for wrapping long line in pager, diff, and stage views.
126    Enable using: `set wrap-lines = yes`. (GH #2)
127  - User-defined commands prefixed with a '?' means prompt before
128    execution. Example: `bind main B !?git rebase -i %(commit)`.
129  - User-defined commands prefixed with a '<' means exit after execution.
130    Example: `bind main C !<git commit`. (GH #66)
131  - User-defined commands are executed unquoted to support shell commands.
132    Example: `bind generic I !@sh -c "echo -n %(commit) | xclip -selection c"`.
133    (GH #65)
134  - Configure case-insensitive searches using: `set ignore-case = yes`.
135  - Add "deleted mode" line type for better diff coloring.
136  - Open editor when requesting edit action from within a file diff.
137  - Update AX_WITH_CURSES to build under Cygwin.
138  - Improve tigrc(5) documentation. (Debian #682766)
139  - Allow to build on Mac OS 10.7 without the configure script. (GH #25)
140  - Add option to split the view vertically instead of horizontally.
141    Example: `set vertical-split = yes'. (GH #76)
142  - Add 'show-id' and 'id-width' options to configure the display of
143    commit IDs in the main view and ID width in the blame view. (GH #77)
144  - Allow to override Git based encoding to UTF-8 by setting
145    'i18n.commitencoding' or 'gui.encoding'.
146  - Improve autobuild support to track generated files and work with
147    autoreconf 2.61.
148  - Commit IDs are read from stdin when --stdin is given; works for main
149    and diff view, e.g. `tig --no-walk --stdin < cherry-picks.txt`.
150  - Add option to disable focusing of the child view when it's opened.
151    Disable using: `set focus-child = no`. (GH #83)
152  - Allow to open blob related with added content in a diff. (GH #91)
154 Bug fixes:
156  - Fix commit graph regression when a path spec is specified. (GH #53)
157  - Main view: only show staged/unstaged changes for the current branch.
158  - Support submodules created with current version of git. (GH #54)
159  - Fix diff status message for file diffs with no content changes.
160  - Fix parent blaming when Tig is launched in subdirectory. (GH #70)
161  - Do not show deleted branch when reloading the branch view.
163 tig-1.0
164 -------
166 The master repository is git://github.com/jonas/tig.git, and the old
167 master repository (http://jonas.nitro.dk/tig/tig.git) will be retired.
169 Improvements:
171  - Use git-log(1)s default commit ordering. The old behavior can be
172    restored by adding `set commit-order = topo` to ~/.tigrc.
173  - Support staging of single lines. Bound to '1' default. (GH #21)
174  - Use +<lineno> to open the initial view at an arbitrary line. (GH #20)
175  - Add show-notes ~/.tigrc option. Notes are displayed by default.
176  - Support jumping to specific SHAs in the main view.
177  - Decorate replaced commits.
178  - Display line numbers in main view.
179  - Colorize binary diff stats. (GH #17)
180  - Custom colorization of lines matching a string prefix (GH #16).
181    Example configuration: color "Reported-by:" green default
182  - Use Git's color settings for the main, status and diff views.
183    Put `set read-git-colors = no` in ~/.tigrc to disable.
184  - Handle editor options with multiple arguments. (GH #12)
185  - Show filename when running tig blame with copy detection. (GH #19)
186  - Use 'source <path>' command to load additional files from ~/.tigrc
187  - User-defined commands prefixed with '@' are run with no console
188    output, e.g.
190         bind generic 3 !@rm sys$command
192  - Make display of space changes togglable in the diff and stage view.
193    Bound to 'W' by default.
194  - Use per-file encoding specified in gitattributes(5) for blobs and
195    unstaged files.
196  - Obsolete commit-encoding option and pass --encoding=UTF-8 to revision
197    commands.
198  - Main view: show uncommitted changes as staged/unstaged commits.
199    Can be disabled by putting `set show-changes = no` in ~/.tigrc.
200  - Add %(prompt) external command variable, which will prompt for the
201    argument value.
202  - Log information about Git commands when the TIG_TRACE environment
203    variable is set. Example: `TIG_TRACE=/tmp/tig.log tig`
204  - Branch view: Show the title of the last commit.
205  - Increase the author auto-abbreviation threshold to 10. (GH #49)
206  - For old commits show number of years in relative dates. (GH #50)
208 Bug fixes:
210  - Fix navigation behavior when going from branch to main view. (GH #38)
211  - Fix segfault when sorting the tree view by author name.
212  - Fix diff stat navigation for unmodified files with stat changes.
213  - Show branches/refs which names are a substring of the current branch.
214  - Stage view: fix off-by-one error when jumping to a file in a diff
215    with only one file.
216  - Fix diff-header colorization. (GH #15)
217   
218 tig-0.18
219 --------
221 Incompatibilities:
223  - Remove support for the deprecated TIG_{MAIN,DIFF,LOG,TREE,BLOB}_CMD
224    environment variables.
226 Improvements:
228  - Pressing enter on diff stat file lines will jump to file's diff.
229  - Naïvely color blame IDs to distinguish lines.
230  - Document palette color options used for revision graph and blame IDs.
231  - Add support for blaming diff lines.
232  - Add diff-context option and bindings to increase the diff context in
233    the diff and stage view.
234  - (GH-6) Make blame configurable via extra options passed from the command
235    line and blame-options setting from ~/.tigrc. For example:
236    
237         set blame-options = -C -C -C
239 Bug fixes:
241  - Expand browsing state variables for prompt. (LP #694780, Debian #635546)
242  - Fix segfault when sorting the branch view by author.
243  - Expand %(directory) to . for the root directory. (GH-3)
244  - Accept 'utf-8' for the line-graphics option as indicated in the docs.
245  - Use erasechar() to check for the correct backspace character.
247 tig-0.17
248 --------
250 Improvements:
252  - Start rewrite of the revision graph renderer. Three modes are
253    supported UTF-8, ncurses line graphics, and ASCII. Also, enable
254    revision graph rendering by default.
256 Bug fixes:
258  - Fix ncurses 5.8 issue by passing non-zero column size to newwin().
259  - Fix opening of diffs when browsing branches.
261 tig-0.16.2
262 ----------
264 Bug fixes:
266  - Fix regression causing empty tree view.
267  - Fix set_tabsize() compile error for older versions of ncurses.
269 tig-0.16.1
270 ----------
272 Improvements:
274  - Add scroll-first-col action to jump to the first column. Bound to '|'
275    by default.
276  - Add 'status-untracked-dirs' option to ignore unknown directories
277    contents in the status view. On by default.
279 Bug fixes:
281  - Fix 'tig show <commit>' to show the provided commit.
282  - Fix problem with empty diff views when file specs were passed on the
283    command line.
284  - Fix segfault when starting Tig in pager mode.
286 tig-0.16
287 --------
289 Incompatibilities:
291  - Encode everything internally as UTF-8. This can affect performance,
292    but should in general improve handling of character lengths etc.
293    Also, to properly handle UTF-8 environments use ncurses with wide
294    character support.
295  - The use of TIG_{MAIN,DIFF,LOG,TREE,BLOB}_CMD environment variables
296    has been deprecated. To allow configuration of the diff view,
297    TIG_DIFF_OPTS can be used.
299 Improvements:
301  - Plug several memory leaks.
302  - Command line arguments are split into diff, revision, and file
303    arguments and made available as %(diffargs), %(revargs), and
304    %(fileargs). Diff view will limit diffs using %(fileargs).
305  - Status view: update the file variable when a line is selected so
306    %(file) works as expected.
307  - Branch view: add %(branch) symbol providing access to the selected
308    branch.
309  - Branch view: add entry to browse all branches (uses git-log's --all
310    flag).
311  - Abbreviation of author names can now be configured and toggled.
312  - Mark detached heads with [HEAD].
313  - Add support for displaying dates in local time.
315 Bug fixes:
317  - Status view: fix usage from sub directories, which was broken by the
318    changes made to support blame view from sub directories.
319  - Fix text expansion to not truncate long lines
320  - Fix parsing of boolean show-date values.
321  - Fix relative date.
322  - Fix unbind to behave as if the keybinding was never defined.
323  - Fix unbind to also cover built-in run requests.
324  - Fix parsing of unknown keymap names.
325  - Blame view: fix parent blame to detect renames. It uses "previous"
326    line info from the blame porcelain output added in Git version 1.6.3.
328 tig-0.15
329 --------
331 Incompatibilities:
333  - Setting the cursor color no longer automatically sets the text to
334    bold. The old 'lazy' behavior was a bug.
335  - Remove check for git-repo-config, which was officially deprecated in
336    Git version 1.5.4. The configure script no longer depends on Git
337    being installed.
339 Improvements:
341  - Provide the manual as a man page named tigmanual(7).
342  - Add ability to toggle between showing shorter dates (without time
343    info) and relative dates. Use 'D' to toggle between date formats.
344  - Show the active (instead of the default) keybindings in the help
345    view. Furthermore, honor the keymap when suggesting actions in the
346    help messages.
347  - Add branch view for choosing which branch to display in the main
348    view. Bound to 'H' by default.
349  - Tree view: show entry to parent directory ('..') when running from
350    subdirectory.
351  - Tree view: sort entries by name, date or author. Toggling is bound to
352    'i' by default, with 'I' controlling whether or not to sort in
353    ascending order.
354  - Make height of the lower view in a split view configurable by setting
355    the 'split-view-height' variable to a number or a percentage.
356    Defaults to 2/3 of the total view height.
357  - Allow multiple text attributes for color commands:
359         color cursor white blue underline bold
361 Bug fixes:
363  - Blame view: fix loading of blame data when opened from the tree view
364    and CWD is not the repo root. (Debian bug 540766)
365  - Tree view: fix searching.
367 tig-0.14.1
368 ----------
370 Improvements:
372  - Status view: improve "on branch" information inspired by the prompt
373    code in Git's bash completion script.
374  - Colors for 256-capable terminals can be specified as colorN.
375  - Entering a number in the prompt will jump to that line number.
376  - Handle core.worktree by setting GIT_DIR and GIT_WORK_TREE.
377  - Make behavior of horizontal scrolling configurable by setting the
378    'horizontal-scroll' variable to a number or a percentage. Defaults to
379    scrolling 50% of the view width.
381 Bug fixes:
383  - Status view: show error when failing to open a file.
384  - Status view: report failures to update a file.
385  - Blame view: fix problem with uninitialized variable.
386  - Blame view: use line number information when loading blame for
387    specific commit.
388  - Fix handling of quoted strings in the config file.
389  - Fix horizontal scrolling glitches.
391 tig-0.14
392 --------
394 Incompatibilities:
396  - The screen-resize action has been deprecated. It had no real use for
397    users and was never meant to be exposed.
398  - The "tree-parent" action was renamed to "parent". Warnings will be
399    emitted for transition.
400  - Remove parsing of deprecated option -S and subcommands log and diff.
401  - The "author" color replaces "main-author". Setting the latter will
402    now set the "author" color.
404 Improvements:
406  - Horizontal scrolling. Bound to Left/Right by default.
407  - Read tigrc(5) options from Git configuration files using the syntax:
409         [tig] show-rev-graph = true
410         [tig "color"] cursor = yellow red bold 
411         [tig "bind"] generic = P parent
413  - Tree view: avoid flickering when updating.
414  - Tree view: annotate entries with commit information.
415  - Tree & blob view: open any blob in an editor.
416  - Stage & main view: restore view position when reloading.
417  - Blame view: load blame for parent commit. For merge commits the parent
418    is queried. Bound to ',' by default via the existing "parent" action.
419  - Abbreviate author names to initials when the width of the author column
420    is below 6 characters.
422 Bug fixes:
424  - Tree view: fix memory corruption bug when updating.
425  - Tree view: improve handling of empty trees.
426  - Status view: fix reverting of unmerged files.
427  - Fix regression for non-UTF-8 locales corrupting the view data.
428  - Fix regression parsing multiple spaces in ~/.tigrc.
430 tig-0.13
431 --------
433 Incompatibilities:
435  - Commands from the environment (e.g. TIG_MAIN_CMD) will no longer have
436    access to shell features, such as subshells and variable expansion.
437    The easiest way to upgrade your configuration is to put such commands
438    in a script file or as a Git alias.
440 Improvements:
442  - Display repository references in the sorted order: tags, heads,
443    tracked remotes, remotes.
444  - Add bash completion for blame.
445  - Tree view: edit files of the current branch.
446  - Run requests: new identifiers %(directory), %(file), and %(ref)
447  - Improve responsiveness and view loading speed by using select(2).
449 Bug fixes:
451  - Separate blame revision and file argument by "--" to avoid problems.
452  - Main view: fix redrawing of the last commit wrt. the revision graph.
453  - Fix waiting for input after executing a run request in pager mode.
454  - Status & stage view: refuse to open directories and deleted files.
455  - Tree view: show error when requesting blame for all non-file entries.
456  - Do not draw loading views, which are not displayed.
457  - Fix launching of mergetool from a subdirectory.
459 tig-0.12.1
460 ----------
462 Improvements:
464  - Status view: revert uncommitted diff chunks and unstaged files with
465    changes. Bound to '!' by default.
466  - Main view: use --topo-order also when rev-list arguments are given on
467    the command line.
468  - Log view: support for refreshing.
470 Bug fixes:
472  - Status view: use ls-files' --exclude-standard so user specific ignore
473    rules are effective. The option was added in Git version 1.5.4.
474  - Stage view: fix assertion failure triggered when updating while
475    status view is not displayed.
476  - Help view: avoid confusion by showing "(no key)" instead of "'?'" for
477    unbound requests.
478  - Reload repository references when refreshing the main (and log) view.
479  - Do not maximize views when refreshing.
481 tig-0.12
482 --------
484 Improvements:
486  - F5 also refreshes the current view.
487  - Allow line graphics to be disabled with new line-graphics option.
488  - Main view: also include the reference names when searching.
489  - Main view: support for refreshing.
490  - Main view: disable boundary commits by default. Use --boundary when
491    they should be shown. (Debian bug 498628)
492  - Stage view: add stage-next action to jump to next diff chunk that can
493    be staged. By default bound to '@'.
494  - Configure: check for the ncurses header files.
495  - Add author-width option to customize the width of the author column.
496    For example, put the following in ~/.tigrc: set author-width = 10
498 Bug fixes:
500  - Fix regression when staging all diff chunks in a section.
501  - Bind the maximize view action to 'O'; it conflicted with the
502    keybinding to launch the merge tool in the status view.
503  - Fix problem with $(cmd) usage in shell code. Some shells (jsh)
504    installed as /bin/sh does not support it.
505  - Do not show incomplete boundary commits when --no-walk is used.
506  - Documentation: Rename gitlink macro to support AsciiDoc 8.2.3.
507  - Ignore pipe reads with errno "Success" reported after a signals,
508    for example when refreshing doing background loading.
510 tig-0.11
511 --------
513 Incompatibilities:
515  - Remove parsing of deprecated options: -g, -l, -d.
516  - The first seen '--' will stop option parsing and is passed to Git
517    instead of breaking out of Tig's option parsing.
519 New features:
521  - Blame view; bound to 'B' by default, reachable from the command line
522    and the tree, status, and stage views.
523  - Blame/main view: allow display of date, author, and references to be
524    toggled on/off. Bound to 'D', 'A', and 'F' respectively.
525  - Add action to maximize the current view.
527 Improvements:
529  - Show the current branch in the status view.
530  - Show local/light-weight tags.
532 Bug fixes:
534  - Fix regressions for the pager mode.
535  - Fix refreshing of the index with working directory info.
537 tig-0.10.1
538 ----------
540 Improvements:
542  - Status view: detect renamed files and show them with 'R'.
543  - Status view: refresh the index to avoid "empty diffs".
544  - Diff view: make diff headers more verbose to include e.g. committer.
545  - Configure: check for the ncursesw library.
547 Bug fixes:
549  - Fix UTF-8 handling for tag names and commit messages.
550  - Fix the check for git-config(1) in configure to handle the case when
551    Git has been installed using a libexecdir which is not in the path.
552  - Fix replacing of SYSCONFDIR when installing from released tarballs.
554 tig-0.10
555 ---------
557 Incompatibilities:
559  - Deprecate most Tig specific command line options to make Tig more
560    compatible with gitk. The deprecated options are: -g, -l, -d, and -S.
561    Use of any of them will result in a warning being printed to stderr.
562    Instead of '-S', use the new 'status' subcommand.
563  - Make man page building depend on DocBook XSL version >= 1.72.0.
564  - Install man pages in $(prefix)/share/man.
565  - Implement the cherry pick action (bound to 'C') using new support for
566    running external commands. This obsoletes the TIG_CHEERY_PICK
567    environment variable
569 New features:
571  - Add support for binding keys to external commands. To bind '.' to
572    running git-commit(1), add the line: "bind generic . !git commit" to
573    your ~/.tigrc. Each command can have replacement string such as
574    %(commit), %(head), and %(blob), which are substituted before the
575    command is run.
576  - Add system-wide configuration file defaulting to $(prefix)/etc/tigrc.
577  - Add the environment variables TIGRC_USER and TIGRC_SYSTEM to change
578    user and system-wide configuration files, respectively.
580 Improvements:
582  - Main view: color the revision graph.
583  - Main view: show boundary commits; they are marked with '^' in the
584    revision graph.
585  - Tree view: add tree-parent action to jump to view of the parent tree.
586    Bound to ',' by default.
587  - Allow the default terminal colors to be overwritten. To use black
588    text on white, add the line "color default white black" to your
589    ~/.tigrc.
590  - Misc. documentation improvements.
592 Bug fixes:
594  - Use git-diff-index(1) and git-diff-files(1) instead of git-diff(1) to
595    avoid running external diff drivers.
596  - Use --no-color when calling git-log(1).
597  - Fix crash when opening mergetool for lines that are not unmerged.
599 tig-0.9.1
600 ---------
602 Incompatibilities:
604  - Make the clean rule to never remove generated documentation files.
605    Use the distclean rule for accomplishing this.
607 New features:
609  - Add support for cherry-picking commits in the main view to the
610    current branch. Bound to 'C' by default.
612 Improvements:
614  - Add support for launching git-mergetool(1) from the status view.
615    Bound to 'M' by default.
616  - Add support for refreshing/reloading the status view
617  - Detect working trees and disable the status view when it is missing.
619 Bug fixes:
621  - Fix iconv() checking in configure.
622  - Fix editor invocation to make paths relative to the project root.
623  - Fix out-of-range current line when reloading the status view.
624  - Include autoconf files in the tarball generated by `make dist`.
626 tig-0.9
627 -------
629 New features:
631  - Add bash completion script for Tig (contrib/tig-completion.bash).
632  - Add optional autoconf-based build infrastructure.
633  - Add stage view for showing changes in the working tree and add
634    support for staging individual diff chunks for commit.
636 Improvements:
638  - Status view: allow all files in a section to be staged for commit.
639  - Status view: Add support for opening files in an editor. Bound to 'e'
640    by default.
641  - Tree view: use a stack for remembering the lines for parent tree.