upstream/mercurial-mirror Files · contrib/win32/ReadMe.html

cmdutil: add class to restore dirstate during unexpected failure...

cmdutil: add class to restore dirstate during unexpected failure Before this patch, after "dirstate.write()" execution, there was no way to restore dirstate to the original status before "dirstate.write()". In some code paths, "dirstate.invalidate()" is used as a kind of "restore .hg/dirstate to the original status", but it just avoids writing changes in memory out, and doesn't actually restore the ".hg/dirstate" file. To fix the issue that the recent (in memory) dirstate isn't visible to external processes (e.g. "precommit" hooks), "dirstate.write()" should be invoked before invocation of external processes. But at the same time, ".hg/dirstate" should be restored to its content before "dirstate.write()" during an unexpected failure in some cases. This patch adds the class "dirstateguard" to easily restore ".hg/dirstate" during unexpected failures. Typical usecase of it is: # (1) build dirstate up .... # (2) write dirstate out, and backup ".hg/dirstate" dsguard = dirstateguard(repo, 'scopename') try: # (3) execute somethig to do: # this may imply making some additional changes on dirstate .... # (4) unlink backed-up dirstate file at the end of dsguard scope dsguard.close() finally: # (5) if execution is aborted before "dsguard.close()", # ".hg/dirstate" is restored from the backup dsguard.release() For this kind of issue, an "extending transaction" approach (in https://titanpad.com/mercurial32-sprint) seems to not be suitable, because: - transaction nesting occurs in some cases (e.g. "shelve => rebase"), and - "dirstate" may be already modified since the beginning of OUTER transaction scope, then - dirstate should be backed up into the file other than "dirstate.journal" at the beginning of INNER transaction scope, but - such alternative backup files are useless for transaction itself, and increases complication of its implementation "transaction" and "dirstateguard" differ from each other also in "what it should do for .hg/dirstate" in cases other than success. ============== ======= ======== ============= type success fail "hg rollback" ============== ======= ======== ============= transaction keep keep restore dirstateguard keep restore (not implied) ============== ======= ======== ============= Some collaboration between transaction and dirstate will probably be introduced in the future. But this layer is needed in all cases.

Jesus Cea - - Load All Authors

File last commit:

r24191:8fe5fc8d default


                r24991:4169a4f8

default

Download file

             ReadMe.html
        
                    162 lines
            
             | 4.6 KiB
            
                | text/html
            
             |
                HtmlLexer
            
             / contrib / win32 / ReadMe.html
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

      <html>

        <head>

          <title>Mercurial for Windows</title>

          <meta http-equiv="Content-Type" content="text/html;charset=utf-8" >

          <style type="text/css">

            <!--

            html {

              font-family: sans-serif;

              margin: 1em 2em;

            }

            p {

              margin-top: 0.5em;

              margin-bottom: 0.5em;

            }

            pre {

              margin: 0.25em 0em;

              padding: 0.5em;

              background-color: #EEE;

              border: thin solid #CCC;

            }

            .indented {

              padding-left: 10pt;

            }

            -->

          </style>

        </head>

        <body>

          <h1>Mercurial for Windows</h1>

          <p>Welcome to Mercurial for Windows!</p>

          <p>

            Mercurial is a command-line application. You must run it from

            the Windows command prompt (or if you're hard core, a <a

            href="http://www.mingw.org/">MinGW</a> shell).

          </p>

          <p class="indented">

            <i>Note: the standard <a href="http://www.mingw.org/">MinGW</a>

            msys startup script uses rxvt which has problems setting up

            standard input and output. Running bash directly works

            correctly.</i>

          </p>

          <p>

            For documentation, please visit the <a

            href="http://mercurial.selenic.com/">Mercurial web site</a>.

            You can also download a free book, <a

            href="http://hgbook.red-bean.com/">Mercurial: The Definitive

            Guide</a>.

          </p>

          <p>

            By default, Mercurial installs to <tt>C:\Program

            Files\Mercurial</tt>. The Mercurial command is called

            <tt>hg.exe</tt>.

          </p>

          <h1>Testing Mercurial after you've installed it</h1>

          <p>

            The easiest way to check that Mercurial is installed properly is

            to just type the following at the command prompt:

          </p>

          <pre>

      hg

      </pre>

          <p>

            This command should print a useful help message. If it does,

            other Mercurial commands should work fine for you.

          </p>

          <h1>Configuration notes</h1>

          <h4>Default editor</h4>

          <p>

            The default editor for commit messages is 'notepad'. You can set

            the <tt>EDITOR</tt> (or <tt>HGEDITOR</tt>) environment variable

            to specify your preference or set it in <tt>mercurial.ini</tt>:

          </p>

          <pre>

      [ui]

      editor = whatever

      </pre>

          <h4>Configuring a Merge program</h4>

          <p>

            It should be emphasized that Mercurial by itself doesn't attempt

            to do a Merge at the file level, neither does it make any

            attempt to Resolve the conflicts.

          </p>

          <p>

            By default, Mercurial will use the merge program defined by the

            <tt>HGMERGE</tt> environment variable, or uses the one defined

            in the <tt>mercurial.ini</tt> file. (see <a

            href="http://mercurial.selenic.com/wiki/MergeProgram">MergeProgram</a>

            on the Mercurial Wiki for more information)

          </p>

          <h1>Reporting problems</h1>

          <p>

            Before you report any problems, please consult the <a

            href="http://mercurial.selenic.com/">Mercurial web site</a>

            and see if your question is already in our list of <a

            href="http://mercurial.selenic.com/wiki/FAQ">Frequently

            Answered Questions</a> (the "FAQ").

          </p>

          <p>

            If you cannot find an answer to your question, please feel free

            to send mail to the Mercurial mailing list, at <a

            href="mailto:mercurial@selenic.com">mercurial@selenic.com</a>.

            <b>Remember</b>, the more useful information you include in your

            report, the easier it will be for us to help you!

          </p>

          <p>

            If you are IRC-savvy, that's usually the fastest way to get

            help. Go to <tt>#mercurial</tt> on <tt>irc.freenode.net</tt>.

          </p>

          <h1>Author and copyright information</h1>

          <p>

            Mercurial was written by <a href="http://www.selenic.com">Matt

            Mackall</a>, and is maintained by Matt and a team of volunteers.

          </p>

          <p>

            The Windows installer was written by <a

            href="http://www.serpentine.com/blog">Bryan O'Sullivan</a>.

          </p>

          <p>

            Mercurial is Copyright 2005-2015 Matt Mackall and others. See

            the <tt>Contributors.txt</tt> file for a list of contributors.

          </p>

          <p>

            Mercurial is free software; you can redistribute it and/or

            modify it under the terms of the <a

            href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU

            General Public License version 2</a> or any later version.

          </p>

          <p>

            Mercurial is distributed in the hope that it will be useful, but

            <b>without any warranty</b>; without even the implied warranty

            of <b>merchantability</b> or <b>fitness for a particular

            purpose</b>. See the GNU General Public License for more

            details.

          </p>

        </body>

      </html>

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
				<html>
				<head>
				<title>Mercurial for Windows</title>
				<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
				<style type="text/css">
				<!--
				html {
				font-family: sans-serif;
				margin: 1em 2em;
				}

				p {
				margin-top: 0.5em;
				margin-bottom: 0.5em;
				}

				pre {
				margin: 0.25em 0em;
				padding: 0.5em;
				background-color: #EEE;
				border: thin solid #CCC;
				}

				.indented {
				padding-left: 10pt;
				}
				-->
				</style>
				</head>

				<body>
				<h1>Mercurial for Windows</h1>

				<p>Welcome to Mercurial for Windows!</p>

				<p>
				Mercurial is a command-line application. You must run it from
				the Windows command prompt (or if you're hard core, a <a
				href="http://www.mingw.org/">MinGW</a> shell).
				</p>

				<p class="indented">
				<i>Note: the standard <a href="http://www.mingw.org/">MinGW</a>
				msys startup script uses rxvt which has problems setting up
				standard input and output. Running bash directly works
				correctly.</i>
				</p>

				<p>
				For documentation, please visit the <a
				href="http://mercurial.selenic.com/">Mercurial web site</a>.
				You can also download a free book, <a
				href="http://hgbook.red-bean.com/">Mercurial: The Definitive
				Guide</a>.
				</p>

				<p>
				By default, Mercurial installs to <tt>C:\Program
				Files\Mercurial</tt>. The Mercurial command is called
				<tt>hg.exe</tt>.
				</p>

				<h1>Testing Mercurial after you've installed it</h1>

				<p>
				The easiest way to check that Mercurial is installed properly is
				to just type the following at the command prompt:
				</p>

				<pre>
				hg
				</pre>

				<p>
				This command should print a useful help message. If it does,
				other Mercurial commands should work fine for you.
				</p>

				<h1>Configuration notes</h1>
				<h4>Default editor</h4>
				<p>
				The default editor for commit messages is 'notepad'. You can set
				the <tt>EDITOR</tt> (or <tt>HGEDITOR</tt>) environment variable
				to specify your preference or set it in <tt>mercurial.ini</tt>:
				</p>
				<pre>
				[ui]
				editor = whatever
				</pre>

				<h4>Configuring a Merge program</h4>
				<p>
				It should be emphasized that Mercurial by itself doesn't attempt
				to do a Merge at the file level, neither does it make any
				attempt to Resolve the conflicts.
				</p>

				<p>
				By default, Mercurial will use the merge program defined by the
				<tt>HGMERGE</tt> environment variable, or uses the one defined
				in the <tt>mercurial.ini</tt> file. (see <a
				href="http://mercurial.selenic.com/wiki/MergeProgram">MergeProgram</a>
				on the Mercurial Wiki for more information)
				</p>

				<h1>Reporting problems</h1>

				<p>
				Before you report any problems, please consult the <a
				href="http://mercurial.selenic.com/">Mercurial web site</a>
				and see if your question is already in our list of <a
				href="http://mercurial.selenic.com/wiki/FAQ">Frequently
				Answered Questions</a> (the "FAQ").
				</p>

				<p>
				If you cannot find an answer to your question, please feel free
				to send mail to the Mercurial mailing list, at <a
				href="mailto:mercurial@selenic.com">mercurial@selenic.com</a>.
				<b>Remember</b>, the more useful information you include in your
				report, the easier it will be for us to help you!
				</p>

				<p>
				If you are IRC-savvy, that's usually the fastest way to get
				help. Go to <tt>#mercurial</tt> on <tt>irc.freenode.net</tt>.
				</p>

				<h1>Author and copyright information</h1>

				<p>
				Mercurial was written by <a href="http://www.selenic.com">Matt
				Mackall</a>, and is maintained by Matt and a team of volunteers.
				</p>

				<p>
				The Windows installer was written by <a
				href="http://www.serpentine.com/blog">Bryan O'Sullivan</a>.
				</p>

				<p>
				Mercurial is Copyright 2005-2015 Matt Mackall and others. See
				the <tt>Contributors.txt</tt> file for a list of contributors.
				</p>

				<p>
				Mercurial is free software; you can redistribute it and/or
				modify it under the terms of the <a
				href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt">GNU
				General Public License version 2</a> or any later version.
				</p>

				<p>
				Mercurial is distributed in the hope that it will be useful, but
				<b>without any warranty</b>; without even the implied warranty
				of <b>merchantability</b> or <b>fitness for a particular
				purpose</b>. See the GNU General Public License for more
				details.
				</p>
				</body>
				</html>