Philip Oakley 540e7bc477 doc: pretty-formats note wide char limitations, and add tests
The previous commits added clarifications to the column alignment
placeholders, note that the spaces are optional around the parameters.

Also, a proposed extension [1] to allow hard truncation (without
ellipsis '..') highlighted that the existing code does not play well
with wide characters, such as Asian fonts and emojis.

For example, N wide characters take 2N columns so won't fit an odd number
column width, causing misalignment somewhere.

Further analysis also showed that decomposed characters, e.g. separate
`a` + `umlaut` Unicode code-points may also be mis-counted, in some cases
leaving multiple loose `umlauts` all combined together.

Add some notes about these limitations, and add basic tests to demonstrate
them.

The chosen solution for the tests is to substitute any wide character
that overlaps a splitting boundary for the unicode vertical ellipsis
code point as a rare but 'obvious' substitution.

An alternative could be the substitution with a single dot '.' which
matches regular expression usage, and our two dot ellipsis, and further
in scenarios where the bulk of the text is wide characters, would be
obvious. In mainly 'ascii' scenarios a singleton emoji being substituted
by a dot could be confusing.

It is enough that the tests fail cleanly. The final choice for the
substitute character can be deferred.

[1]
https://lore.kernel.org/git/20221030185614.3842-1-philipoakley@iee.email/

Signed-off-by: Philip Oakley <philipoakley@iee.email>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-01-19 14:35:15 -08:00
2023-01-16 12:07:46 -08:00
2022-10-07 17:19:59 -07:00
2022-12-11 01:27:25 +08:00
2023-01-02 21:37:19 +09:00
2022-07-10 14:43:34 -07:00
2022-10-06 09:59:17 -07:00
2022-08-03 13:36:09 -07:00
2022-10-12 09:13:25 -07:00
2022-10-30 21:04:44 -04:00
2023-01-08 10:28:34 +09:00
2023-01-02 21:37:18 +09:00
2022-07-19 12:45:31 -07:00
2022-12-19 11:46:17 +09:00
2023-01-16 12:07:47 -08:00
2022-03-28 10:25:52 -07:00
2022-10-25 15:44:18 -07:00
2022-12-14 18:32:26 +09:00
2022-11-14 17:42:46 -05:00
2022-04-06 15:21:59 -07:00
2022-05-02 09:50:37 -07:00
2022-09-14 12:56:39 -07:00
2022-09-14 12:56:39 -07:00
2022-12-15 09:09:38 +09:00
2022-09-14 12:56:39 -07:00
2022-10-30 21:04:41 -04:00
2022-08-29 14:55:11 -07:00
2022-08-22 15:08:30 -07:00
2022-09-14 12:56:39 -07:00
2022-12-14 18:32:26 +09:00
2022-12-26 11:42:05 +09:00
2022-12-01 18:38:07 +09:00
2022-10-30 14:04:51 -04:00
2022-08-30 14:16:49 -07:00
2022-10-24 12:45:26 -07:00
2022-10-24 12:45:26 -07:00
2023-01-02 21:37:18 +09:00
2022-05-02 09:50:37 -07:00
2022-12-26 11:42:05 +09:00

Build status

Git - fast, scalable, distributed revision control system

Git is a fast, scalable, distributed revision control system with an unusually rich command set that provides both high-level operations and full access to internals.

Git is an Open Source project covered by the GNU General Public License version 2 (some parts of it are under different licenses, compatible with the GPLv2). It was originally written by Linus Torvalds with help of a group of hackers around the net.

Please read the file INSTALL for installation instructions.

Many Git online resources are accessible from https://git-scm.com/ including full documentation and Git related tools.

See Documentation/gittutorial.txt to get started, then see Documentation/giteveryday.txt for a useful minimum set of commands, and Documentation/git-<commandname>.txt for documentation of each command. If git has been correctly installed, then the tutorial can also be read with man gittutorial or git help tutorial, and the documentation of each command with man git-<commandname> or git help <commandname>.

CVS users may also want to read Documentation/gitcvs-migration.txt (man gitcvs-migration or git help cvs-migration if git is installed).

The user discussion and development of Git take place on the Git mailing list -- everyone is welcome to post bug reports, feature requests, comments and patches to git@vger.kernel.org (read Documentation/SubmittingPatches for instructions on patch submission and Documentation/CodingGuidelines).

Those wishing to help with error message, usage and informational message string translations (localization l10) should see po/README.md (a po file is a Portable Object file that holds the translations).

To subscribe to the list, send an email with just "subscribe git" in the body to majordomo@vger.kernel.org (not the Git list). The mailing list archives are available at https://lore.kernel.org/git/, http://marc.info/?l=git and other archival sites.

Issues which are security relevant should be disclosed privately to the Git Security mailing list git-security@googlegroups.com.

The maintainer frequently sends the "What's cooking" reports that list the current status of various development topics to the mailing list. The discussion following them give a good reference for project status, development direction and remaining tasks.

The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood):

  • random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant.
  • stupid. contemptible and despicable. simple. Take your pick from the dictionary of slang.
  • "global information tracker": you're in a good mood, and it actually works for you. Angels sing, and a light suddenly fills the room.
  • "goddamn idiotic truckload of sh*t": when it breaks
Description
No description provided
Readme 758 MiB
Languages
C 50.4%
Shell 38.7%
Perl 4.4%
Tcl 3.1%
Python 0.8%
Other 2.4%