@matheusbsbs / matheus-bagliano / commits / a168c5a2cd

config.txt: move pack.* to a separate file

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Nguyễn Thái Ngọc Duy committed Oct 27, 2018 at 08:23 UTC a168c5a2cdf7f635782302e8f87da1cc5b0b941b

2 files changed +121 -120

Documentation/config.txt

+1 -120

@@ -377,126 +377,7 @@ include::config/mergetool.txt[]

377

378 include::config/notes.txt[]

379

380 -pack.window::

381 - The size of the window used by linkgit:git-pack-objects[1] when no

382 - window size is given on the command line. Defaults to 10.

383 -

384 -pack.depth::

385 - The maximum delta depth used by linkgit:git-pack-objects[1] when no

386 - maximum depth is given on the command line. Defaults to 50.

387 - Maximum value is 4095.

388 -

389 -pack.windowMemory::

390 - The maximum size of memory that is consumed by each thread

391 - in linkgit:git-pack-objects[1] for pack window memory when

392 - no limit is given on the command line. The value can be

393 - suffixed with "k", "m", or "g". When left unconfigured (or

394 - set explicitly to 0), there will be no limit.

395 -

396 -pack.compression::

397 - An integer -1..9, indicating the compression level for objects

398 - in a pack file. -1 is the zlib default. 0 means no

399 - compression, and 1..9 are various speed/size tradeoffs, 9 being

400 - slowest. If not set, defaults to core.compression. If that is

401 - not set, defaults to -1, the zlib default, which is "a default

402 - compromise between speed and compression (currently equivalent

403 - to level 6)."

404 -+

405 -Note that changing the compression level will not automatically recompress

406 -all existing objects. You can force recompression by passing the -F option

407 -to linkgit:git-repack[1].

408 -

409 -pack.island::

410 - An extended regular expression configuring a set of delta

411 - islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]

412 - for details.

413 -

414 -pack.islandCore::

415 - Specify an island name which gets to have its objects be

416 - packed first. This creates a kind of pseudo-pack at the front

417 - of one pack, so that the objects from the specified island are

418 - hopefully faster to copy into any pack that should be served

419 - to a user requesting these objects. In practice this means

420 - that the island specified should likely correspond to what is

421 - the most commonly cloned in the repo. See also "DELTA ISLANDS"

422 - in linkgit:git-pack-objects[1].

423 -

424 -pack.deltaCacheSize::

425 - The maximum memory in bytes used for caching deltas in

426 - linkgit:git-pack-objects[1] before writing them out to a pack.

427 - This cache is used to speed up the writing object phase by not

428 - having to recompute the final delta result once the best match

429 - for all objects is found. Repacking large repositories on machines

430 - which are tight with memory might be badly impacted by this though,

431 - especially if this cache pushes the system into swapping.

432 - A value of 0 means no limit. The smallest size of 1 byte may be

433 - used to virtually disable this cache. Defaults to 256 MiB.

434 -

435 -pack.deltaCacheLimit::

436 - The maximum size of a delta, that is cached in

437 - linkgit:git-pack-objects[1]. This cache is used to speed up the

438 - writing object phase by not having to recompute the final delta

439 - result once the best match for all objects is found.

440 - Defaults to 1000. Maximum value is 65535.

441 -

442 -pack.threads::

443 - Specifies the number of threads to spawn when searching for best

444 - delta matches. This requires that linkgit:git-pack-objects[1]

445 - be compiled with pthreads otherwise this option is ignored with a

446 - warning. This is meant to reduce packing time on multiprocessor

447 - machines. The required amount of memory for the delta search window

448 - is however multiplied by the number of threads.

449 - Specifying 0 will cause Git to auto-detect the number of CPU's

450 - and set the number of threads accordingly.

451 -

452 -pack.indexVersion::

453 - Specify the default pack index version. Valid values are 1 for

454 - legacy pack index used by Git versions prior to 1.5.2, and 2 for

455 - the new pack index with capabilities for packs larger than 4 GB

456 - as well as proper protection against the repacking of corrupted

457 - packs. Version 2 is the default. Note that version 2 is enforced

458 - and this config option ignored whenever the corresponding pack is

459 - larger than 2 GB.

460 -+

461 -If you have an old Git that does not understand the version 2 `*.idx` file,

462 -cloning or fetching over a non native protocol (e.g. "http")

463 -that will copy both `*.pack` file and corresponding `*.idx` file from the

464 -other side may give you a repository that cannot be accessed with your

465 -older version of Git. If the `*.pack` file is smaller than 2 GB, however,

466 -you can use linkgit:git-index-pack[1] on the *.pack file to regenerate

467 -the `*.idx` file.

468 -

469 -pack.packSizeLimit::

470 - The maximum size of a pack. This setting only affects

471 - packing to a file when repacking, i.e. the git:// protocol

472 - is unaffected. It can be overridden by the `--max-pack-size`

473 - option of linkgit:git-repack[1]. Reaching this limit results

474 - in the creation of multiple packfiles; which in turn prevents

475 - bitmaps from being created.

476 - The minimum size allowed is limited to 1 MiB.

477 - The default is unlimited.

478 - Common unit suffixes of 'k', 'm', or 'g' are

479 - supported.

480 -

481 -pack.useBitmaps::

482 - When true, git will use pack bitmaps (if available) when packing

483 - to stdout (e.g., during the server side of a fetch). Defaults to

484 - true. You should not generally need to turn this off unless

485 - you are debugging pack bitmaps.

486 -

487 -pack.writeBitmaps (deprecated)::

488 - This is a deprecated synonym for `repack.writeBitmaps`.

489 -

490 -pack.writeBitmapHashCache::

491 - When true, git will include a "hash cache" section in the bitmap

492 - index (if one is written). This cache can be used to feed git's

493 - delta heuristics, potentially leading to better deltas between

494 - bitmapped and non-bitmapped objects (e.g., when serving a fetch

495 - between an older, bitmapped pack and objects that have been

496 - pushed since the last gc). The downside is that it consumes 4

497 - bytes per object of disk space, and that JGit's bitmap

498 - implementation does not understand it, causing it to complain if

499 - Git and JGit are used on the same repository. Defaults to false.

380 +include::config/pack.txt[]

381

382 pager.<cmd>::

383 If the value is boolean, turns on or off pagination of the

Documentation/config/pack.txt new

+120

@@ -0,0 +1,120 @@

1 +pack.window::

2 + The size of the window used by linkgit:git-pack-objects[1] when no

3 + window size is given on the command line. Defaults to 10.

4 +

5 +pack.depth::

6 + The maximum delta depth used by linkgit:git-pack-objects[1] when no

7 + maximum depth is given on the command line. Defaults to 50.

8 + Maximum value is 4095.

9 +

10 +pack.windowMemory::

11 + The maximum size of memory that is consumed by each thread

12 + in linkgit:git-pack-objects[1] for pack window memory when

13 + no limit is given on the command line. The value can be

14 + suffixed with "k", "m", or "g". When left unconfigured (or

15 + set explicitly to 0), there will be no limit.

16 +

17 +pack.compression::

18 + An integer -1..9, indicating the compression level for objects

19 + in a pack file. -1 is the zlib default. 0 means no

20 + compression, and 1..9 are various speed/size tradeoffs, 9 being

21 + slowest. If not set, defaults to core.compression. If that is

22 + not set, defaults to -1, the zlib default, which is "a default

23 + compromise between speed and compression (currently equivalent

24 + to level 6)."

25 ++

26 +Note that changing the compression level will not automatically recompress

27 +all existing objects. You can force recompression by passing the -F option

28 +to linkgit:git-repack[1].

29 +

30 +pack.island::

31 + An extended regular expression configuring a set of delta

32 + islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1]

33 + for details.

34 +

35 +pack.islandCore::

36 + Specify an island name which gets to have its objects be

37 + packed first. This creates a kind of pseudo-pack at the front

38 + of one pack, so that the objects from the specified island are

39 + hopefully faster to copy into any pack that should be served

40 + to a user requesting these objects. In practice this means

41 + that the island specified should likely correspond to what is

42 + the most commonly cloned in the repo. See also "DELTA ISLANDS"

43 + in linkgit:git-pack-objects[1].

44 +

45 +pack.deltaCacheSize::

46 + The maximum memory in bytes used for caching deltas in

47 + linkgit:git-pack-objects[1] before writing them out to a pack.

48 + This cache is used to speed up the writing object phase by not

49 + having to recompute the final delta result once the best match

50 + for all objects is found. Repacking large repositories on machines

51 + which are tight with memory might be badly impacted by this though,

52 + especially if this cache pushes the system into swapping.

53 + A value of 0 means no limit. The smallest size of 1 byte may be

54 + used to virtually disable this cache. Defaults to 256 MiB.

55 +

56 +pack.deltaCacheLimit::

57 + The maximum size of a delta, that is cached in

58 + linkgit:git-pack-objects[1]. This cache is used to speed up the

59 + writing object phase by not having to recompute the final delta

60 + result once the best match for all objects is found.

61 + Defaults to 1000. Maximum value is 65535.

62 +

63 +pack.threads::

64 + Specifies the number of threads to spawn when searching for best

65 + delta matches. This requires that linkgit:git-pack-objects[1]

66 + be compiled with pthreads otherwise this option is ignored with a

67 + warning. This is meant to reduce packing time on multiprocessor

68 + machines. The required amount of memory for the delta search window

69 + is however multiplied by the number of threads.

70 + Specifying 0 will cause Git to auto-detect the number of CPU's

71 + and set the number of threads accordingly.

72 +

73 +pack.indexVersion::

74 + Specify the default pack index version. Valid values are 1 for

75 + legacy pack index used by Git versions prior to 1.5.2, and 2 for

76 + the new pack index with capabilities for packs larger than 4 GB

77 + as well as proper protection against the repacking of corrupted

78 + packs. Version 2 is the default. Note that version 2 is enforced

79 + and this config option ignored whenever the corresponding pack is

80 + larger than 2 GB.

81 ++

82 +If you have an old Git that does not understand the version 2 `*.idx` file,

83 +cloning or fetching over a non native protocol (e.g. "http")

84 +that will copy both `*.pack` file and corresponding `*.idx` file from the

85 +other side may give you a repository that cannot be accessed with your

86 +older version of Git. If the `*.pack` file is smaller than 2 GB, however,

87 +you can use linkgit:git-index-pack[1] on the *.pack file to regenerate

88 +the `*.idx` file.

89 +

90 +pack.packSizeLimit::

91 + The maximum size of a pack. This setting only affects

92 + packing to a file when repacking, i.e. the git:// protocol

93 + is unaffected. It can be overridden by the `--max-pack-size`

94 + option of linkgit:git-repack[1]. Reaching this limit results

95 + in the creation of multiple packfiles; which in turn prevents

96 + bitmaps from being created.

97 + The minimum size allowed is limited to 1 MiB.

98 + The default is unlimited.

99 + Common unit suffixes of 'k', 'm', or 'g' are

100 + supported.

101 +

102 +pack.useBitmaps::

103 + When true, git will use pack bitmaps (if available) when packing

104 + to stdout (e.g., during the server side of a fetch). Defaults to

105 + true. You should not generally need to turn this off unless

106 + you are debugging pack bitmaps.

107 +

108 +pack.writeBitmaps (deprecated)::

109 + This is a deprecated synonym for `repack.writeBitmaps`.

110 +

111 +pack.writeBitmapHashCache::

112 + When true, git will include a "hash cache" section in the bitmap

113 + index (if one is written). This cache can be used to feed git's

114 + delta heuristics, potentially leading to better deltas between

115 + bitmapped and non-bitmapped objects (e.g., when serving a fetch

116 + between an older, bitmapped pack and objects that have been

117 + pushed since the last gc). The downside is that it consumes 4

118 + bytes per object of disk space, and that JGit's bitmap

119 + implementation does not understand it, causing it to complain if

120 + Git and JGit are used on the same repository. Defaults to false.