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