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