Mercurial > hg

comparison tests/test-help.t @ 29747:aba2bb2a6d0f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
help: don't try to render a section on sub-topics This patch subtly changes the behavior of the parsing of "X.Y" values to not set the "section" variable when rendering a known sub-topic. Previously, "section" would be the same as the sub-topic name. This required the sub-topic RST to have a section named the same as the sub-topic name. When I made this change, the descriptions from help.internalstable started being rendered in command line output. This didn't look correct to me, as it didn't match the formatting of main help pages. I corrected this by moving the top section to help.internalstable and changing the section levels of all the "internals" topics. The end result is that "internals" topics now match the rendering of main topics on both the CLI and HTML. And, "internals" topics no longer require a main section matching the name of the topic.
author Gregory Szorc <gregory.szorc@gmail.com>
date Sat, 06 Aug 2016 17:04:22 -0700
parents 31d3ab7985b8
children a1092e2d70a3
comparison
equal deleted inserted replaced
29746:3dbc95f3eb31 29747:aba2bb2a6d0f
927 927
928 $ hg help internals 928 $ hg help internals
929 Technical implementation topics 929 Technical implementation topics
930 """"""""""""""""""""""""""""""" 930 """""""""""""""""""""""""""""""
931 931
932 bundles container for exchange of repository data 932 bundles Bundles
933 changegroups representation of revlog data 933 changegroups Changegroups
934 requirements repository requirements 934 requirements Repository Requirements
935 revlogs revision storage mechanism 935 revlogs Revision Logs
936 936
937 sub-topics can be accessed 937 sub-topics can be accessed
938 938
939 $ hg help internals.changegroups 939 $ hg help internals.changegroups
940 Changegroups 940 Changegroups
941 ============ 941 """"""""""""
942 942
943 Changegroups are representations of repository revlog data, specifically 943 Changegroups are representations of repository revlog data, specifically
944 the changelog, manifest, and filelogs. 944 the changelog, manifest, and filelogs.
945 945
946 There are 3 versions of changegroups: "1", "2", and "3". From a high- 946 There are 3 versions of changegroups: "1", "2", and "3". From a high-
972 972
973 There is a special case chunk that has 0 length ("0x00000000"). We call 973 There is a special case chunk that has 0 length ("0x00000000"). We call
974 this an *empty chunk*. 974 this an *empty chunk*.
975 975
976 Delta Groups 976 Delta Groups
977 ------------ 977 ============
978 978
979 A *delta group* expresses the content of a revlog as a series of deltas, 979 A *delta group* expresses the content of a revlog as a series of deltas,
980 or patches against previous revisions. 980 or patches against previous revisions.
981 981
982 Delta groups consist of 0 or more *chunks* followed by the *empty chunk* 982 Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
1048 In version 2, the delta base node is encoded in the entry in the 1048 In version 2, the delta base node is encoded in the entry in the
1049 changegroup. This allows the delta to be expressed against any parent, 1049 changegroup. This allows the delta to be expressed against any parent,
1050 which can result in smaller deltas and more efficient encoding of data. 1050 which can result in smaller deltas and more efficient encoding of data.
1051 1051
1052 Changeset Segment 1052 Changeset Segment
1053 ----------------- 1053 =================
1054 1054
1055 The *changeset segment* consists of a single *delta group* holding 1055 The *changeset segment* consists of a single *delta group* holding
1056 changelog data. It is followed by an *empty chunk* to denote the boundary 1056 changelog data. It is followed by an *empty chunk* to denote the boundary
1057 to the *manifests segment*. 1057 to the *manifests segment*.
1058 1058
1059 Manifest Segment 1059 Manifest Segment
1060 ---------------- 1060 ================
1061 1061
1062 The *manifest segment* consists of a single *delta group* holding manifest 1062 The *manifest segment* consists of a single *delta group* holding manifest
1063 data. It is followed by an *empty chunk* to denote the boundary to the 1063 data. It is followed by an *empty chunk* to denote the boundary to the
1064 *filelogs segment*. 1064 *filelogs segment*.
1065 1065
1066 Filelogs Segment 1066 Filelogs Segment
1067 ---------------- 1067 ================
1068 1068
1069 The *filelogs* segment consists of multiple sub-segments, each 1069 The *filelogs* segment consists of multiple sub-segments, each
1070 corresponding to an individual file whose data is being described: 1070 corresponding to an individual file whose data is being described:
1071 1071
1072 +--------------------------------------+ 1072 +--------------------------------------+
2870 <tr><td> 2870 <tr><td>
2871 <a href="/help/internals.bundles"> 2871 <a href="/help/internals.bundles">
2872 bundles 2872 bundles
2873 </a> 2873 </a>
2874 </td><td> 2874 </td><td>
2875 container for exchange of repository data 2875 Bundles
2876 </td></tr> 2876 </td></tr>
2877 <tr><td> 2877 <tr><td>
2878 <a href="/help/internals.changegroups"> 2878 <a href="/help/internals.changegroups">
2879 changegroups 2879 changegroups
2880 </a> 2880 </a>
2881 </td><td> 2881 </td><td>
2882 representation of revlog data 2882 Changegroups
2883 </td></tr> 2883 </td></tr>
2884 <tr><td> 2884 <tr><td>
2885 <a href="/help/internals.requirements"> 2885 <a href="/help/internals.requirements">
2886 requirements 2886 requirements
2887 </a> 2887 </a>
2888 </td><td> 2888 </td><td>
2889 repository requirements 2889 Repository Requirements
2890 </td></tr> 2890 </td></tr>
2891 <tr><td> 2891 <tr><td>
2892 <a href="/help/internals.revlogs"> 2892 <a href="/help/internals.revlogs">
2893 revlogs 2893 revlogs
2894 </a> 2894 </a>
2895 </td><td> 2895 </td><td>
2896 revision storage mechanism 2896 Revision Logs
2897 </td></tr> 2897 </td></tr>
2898 2898
2899 2899
2900 2900
2901 2901
2955 <p><input name="rev" id="search1" type="text" size="30" /></p> 2955 <p><input name="rev" id="search1" type="text" size="30" /></p>
2956 <div id="hint">Find changesets by keywords (author, files, the commit message), revision 2956 <div id="hint">Find changesets by keywords (author, files, the commit message), revision
2957 number or hash, or <a href="/help/revsets">revset expression</a>.</div> 2957 number or hash, or <a href="/help/revsets">revset expression</a>.</div>
2958 </form> 2958 </form>
2959 <div id="doc"> 2959 <div id="doc">
2960 <h1>representation of revlog data</h1> 2960 <h1>Changegroups</h1>
2961 <h2>Changegroups</h2>
2962 <p> 2961 <p>
2963 Changegroups are representations of repository revlog data, specifically 2962 Changegroups are representations of repository revlog data, specifically
2964 the changelog, manifest, and filelogs. 2963 the changelog, manifest, and filelogs.
2965 </p> 2964 </p>
2966 <p> 2965 <p>
2998 </p> 2997 </p>
2999 <p> 2998 <p>
3000 There is a special case chunk that has 0 length (&quot;0x00000000&quot;). We 2999 There is a special case chunk that has 0 length (&quot;0x00000000&quot;). We
3001 call this an *empty chunk*. 3000 call this an *empty chunk*.
3002 </p> 3001 </p>
3003 <h3>Delta Groups</h3> 3002 <h2>Delta Groups</h2>
3004 <p> 3003 <p>
3005 A *delta group* expresses the content of a revlog as a series of deltas, 3004 A *delta group* expresses the content of a revlog as a series of deltas,
3006 or patches against previous revisions. 3005 or patches against previous revisions.
3007 </p> 3006 </p>
3008 <p> 3007 <p>
3089 <p> 3088 <p>
3090 In version 2, the delta base node is encoded in the entry in the 3089 In version 2, the delta base node is encoded in the entry in the
3091 changegroup. This allows the delta to be expressed against any parent, 3090 changegroup. This allows the delta to be expressed against any parent,
3092 which can result in smaller deltas and more efficient encoding of data. 3091 which can result in smaller deltas and more efficient encoding of data.
3093 </p> 3092 </p>
3094 <h3>Changeset Segment</h3> 3093 <h2>Changeset Segment</h2>
3095 <p> 3094 <p>
3096 The *changeset segment* consists of a single *delta group* holding 3095 The *changeset segment* consists of a single *delta group* holding
3097 changelog data. It is followed by an *empty chunk* to denote the 3096 changelog data. It is followed by an *empty chunk* to denote the
3098 boundary to the *manifests segment*. 3097 boundary to the *manifests segment*.
3099 </p> 3098 </p>
3100 <h3>Manifest Segment</h3> 3099 <h2>Manifest Segment</h2>
3101 <p> 3100 <p>
3102 The *manifest segment* consists of a single *delta group* holding 3101 The *manifest segment* consists of a single *delta group* holding
3103 manifest data. It is followed by an *empty chunk* to denote the boundary 3102 manifest data. It is followed by an *empty chunk* to denote the boundary
3104 to the *filelogs segment*. 3103 to the *filelogs segment*.
3105 </p> 3104 </p>
3106 <h3>Filelogs Segment</h3> 3105 <h2>Filelogs Segment</h2>
3107 <p> 3106 <p>
3108 The *filelogs* segment consists of multiple sub-segments, each 3107 The *filelogs* segment consists of multiple sub-segments, each
3109 corresponding to an individual file whose data is being described: 3108 corresponding to an individual file whose data is being described:
3110 </p> 3109 </p>
3111 <pre> 3110 <pre>