contrib/wix/help.wxs
author Gregory Szorc <gregory.szorc@gmail.com>
Mon, 22 Aug 2016 19:46:39 -0700
changeset 29859 a1092e2d70a3
parent 28523 045fe7042510
child 30610 66cffa87d2f2
permissions -rw-r--r--
help: internals topic for wire protocol The Mercurial wire protocol is under-documented. This includes a lack of source docstrings and comments as well as pages on the official wiki. This patch adds the beginnings of "internals" documentation on the wire protocol. The documentation should have nearly complete coverage on the lower-level parts of the protocol, such as the different transport mechanims, how commands and arguments are sent, capabilities, and, of course, the commands themselves. As part of writing this documentation, I discovered a number of deficiencies in the protocol and bugs in the implementation. I've started sending patches for some of the issues. I hope to send a lot more. This patch starts with the scaffolding for a new internals page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
     1
<?xml version="1.0" encoding="utf-8"?>
10513
47838dee7d60 contrib/wix: switch *.wxs files to LF eol
Adrian Buehlmann <adrian@cadifra.com>
parents: 10502
diff changeset
     2
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
     3
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
     4
  <?include guids.wxi ?>
13042
bd9bc4123920 wix: add support for x64 native MSI packages
Steve Borho <steve@borho.org>
parents: 12830
diff changeset
     5
  <?include defines.wxi ?>
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
     6
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
     7
  <Fragment>
27684
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
     8
    <ComponentGroup Id='helpFolder'>
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
     9
      <ComponentRef Id='help.root' />
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    10
      <ComponentRef Id='help.internals' />
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    11
    </ComponentGroup>
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    12
  </Fragment>
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    13
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    14
  <Fragment>
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    15
    <DirectoryRef Id="INSTALLDIR">
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    16
      <Directory Id="helpdir" Name="help" FileSource="$(var.SourceDir)">
27684
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    17
        <Component Id="help.root" Guid="$(var.help.root.guid)" Win64='$(var.IsX64)'>
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    18
          <File Name="config.txt" KeyPath="yes" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    19
          <File Name="dates.txt" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    20
          <File Name="diffs.txt" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    21
          <File Name="environment.txt" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    22
          <File Name="extensions.txt" />
14819
b30c889584ef wix: catch up with more added files
Steve Borho <steve@borho.org>
parents: 13042
diff changeset
    23
          <File Name="filesets.txt" />
11491
159233cc9c14 wix: pick up new help topics added between 1.5 and 1.6
Steve Borho <steve@borho.org>
parents: 10828
diff changeset
    24
          <File Name="glossary.txt" />
14819
b30c889584ef wix: catch up with more added files
Steve Borho <steve@borho.org>
parents: 13042
diff changeset
    25
          <File Name="hgignore.txt" />
11491
159233cc9c14 wix: pick up new help topics added between 1.5 and 1.6
Steve Borho <steve@borho.org>
parents: 10828
diff changeset
    26
          <File Name="hgweb.txt" />
12790
6c619c2e8778 wix: add new merge-tools.txt help text
Steve Borho <steve@borho.org>
parents: 11491
diff changeset
    27
          <File Name="merge-tools.txt" />
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    28
          <File Name="multirevs.txt" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    29
          <File Name="patterns.txt" />
16220
939f043ab5ed wix: add phases help text and two more translations (issue 3288)
Steve Borho <steve@borho.org>
parents: 14819
diff changeset
    30
          <File Name="phases.txt" />
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    31
          <File Name="revisions.txt" />
11491
159233cc9c14 wix: pick up new help topics added between 1.5 and 1.6
Steve Borho <steve@borho.org>
parents: 10828
diff changeset
    32
          <File Name="revsets.txt" />
26119
65d2538ac993 wix: avoid an abort with 'hg help -k foo'
Matt Harbison <matt_harbison@yahoo.com>
parents: 16220
diff changeset
    33
          <File Name="scripting.txt" />
12830
d8205dacf9a3 wix: add subrepos help text
Steve Borho <steve@borho.org>
parents: 12790
diff changeset
    34
          <File Name="subrepos.txt" />
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    35
          <File Name="templates.txt" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    36
          <File Name="urls.txt" />
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    37
        </Component>
27684
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    38
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    39
        <Directory Id="help.internaldir" Name="internals">
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    40
          <Component Id="help.internals" Guid="$(var.help.internals.guid)" Win64='$(var.IsX64)'>
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    41
            <File Id="internals.bundles.txt"      Name="bundles.txt" KeyPath="yes" />
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    42
            <File Id="internals.changegroups.txt" Name="changegroups.txt" />
28523
045fe7042510 help: document requirements
Gregory Szorc <gregory.szorc@gmail.com>
parents: 27684
diff changeset
    43
            <File Id="internals.requirements.txt" Name="requirements.txt" />
27684
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    44
            <File Id="internals.revlogs.txt"      Name="revlogs.txt" />
29859
a1092e2d70a3 help: internals topic for wire protocol
Gregory Szorc <gregory.szorc@gmail.com>
parents: 28523
diff changeset
    45
            <File Id="internals.wireprotocol.txt" Name="wireprotocol.txt" />
27684
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    46
          </Component>
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    47
        </Directory>
e9857fbfd072 wix: add help for current internal topics
Matt Harbison <matt_harbison@yahoo.com>
parents: 26119
diff changeset
    48
10828
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    49
      </Directory>
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    50
    </DirectoryRef>
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    51
  </Fragment>
1aa9464ce9ae wix: refactor and new guids.wxi
Adrian Buehlmann <adrian@cadifra.com>
parents: 10513
diff changeset
    52
10513
47838dee7d60 contrib/wix: switch *.wxs files to LF eol
Adrian Buehlmann <adrian@cadifra.com>
parents: 10502
diff changeset
    53
</Wix>