Merge lp:~gz/brz/relocate_brz_log into lp:brz

[Martin Packman]

Relocate the bzr log file out of $HOME.

Relocate the bzr log file out of $HOME

Now under $XDG_CACHE_HOME on nix and %LOCALAPPDATA% on windows.

Setting $BRZ_HOME will override the cache location, to simplify test
isolation, and $BRZ_LOG is still the final word.

Drive-by fix various docs around bzr/brz spelling.

[Jelmer Vernooij (jelmer)]

review: Approve

=== modified file 'breezy/bedding.py'
--- breezy/bedding.py	2019-06-16 01:03:51 +0000
+++ breezy/bedding.py	2019-06-16 20:07:06 +0000
@@ -169,8 +169,10 @@
 
 def cache_dir():
     """Return the cache directory to use."""
+    base = osutils.path_from_environ('BRZ_HOME')
     if sys.platform in "win32":
-        base = win32utils.get_local_appdata_location()
+        if base is None:
+            base = win32utils.get_local_appdata_location()
         if base is None:
             base = win32utils.get_home_location()
     else:

=== modified file 'breezy/gpg.py'
--- breezy/gpg.py	2018-01-24 07:51:44 +0000
+++ breezy/gpg.py	2019-06-16 20:07:06 +0000
@@ -177,7 +177,7 @@
     else:
         # This is not quite worthy of a warning, because some people
         # don't need GPG_TTY to be set. But it is worthy of a big mark
-        # in ~/.brz.log, so that people can debug it if it happens to them
+        # in brz.log, so that people can debug it if it happens to them
         trace.mutter('** Env var TTY empty, cannot set GPG_TTY.'
                      '  Is TTY exported?')
 

=== modified file 'breezy/help_topics/__init__.py'
--- breezy/help_topics/__init__.py	2018-11-20 23:50:57 +0000
+++ breezy/help_topics/__init__.py	2019-06-16 20:07:06 +0000
@@ -601,8 +601,8 @@
     ("BRZ_HOME (Win32)", "Directory holding breezy config dir. Overrides APPDATA and HOME."),
     ("BZR_REMOTE_PATH", "Full name of remote 'brz' command (for brz+ssh:// URLs)."),
     ("BRZ_SSH", "Path to SSH client, or one of paramiko, openssh, sshcorp, plink or lsh."),
-    ("BRZ_LOG", "Location of .brz.log (use '/dev/null' to suppress log)."),
-    ("BRZ_LOG (Win32)", "Location of .brz.log (use 'NUL' to suppress log)."),
+    ("BRZ_LOG", "Location of brz.log (use '/dev/null' to suppress log)."),
+    ("BRZ_LOG (Win32)", "Location of brz.log (use 'NUL' to suppress log)."),
     ("BRZ_COLUMNS", "Override implicit terminal width."),
     ("BRZ_CONCURRENCY", "Number of processes that can be run concurrently (selftest)"),
     ("BRZ_PROGRESS_BAR", "Override the progress display. Values are 'none' or 'text'."),
@@ -634,7 +634,7 @@
     r"""Files
 
 :On Unix:   ~/.config/breezy/breezy.conf
-:On Windows: C:\\Documents and Settings\\username\\Application Data\\Breezy\\2.0\\breezy.conf
+:On Windows: %APPDATA%\\breezy\\breezy.conf
 
 Contains the user's default configuration. The section ``[DEFAULT]`` is
 used to define general configuration that will be applied everywhere.

=== modified file 'breezy/help_topics/en/missing-extensions.txt'
--- breezy/help_topics/en/missing-extensions.txt	2017-07-30 16:59:50 +0000
+++ breezy/help_topics/en/missing-extensions.txt	2019-06-16 20:07:06 +0000
@@ -23,4 +23,4 @@
 
 Breezy will work normally but some operations may be slower.
 
-The specific modules that failed, and why, are listed in .brz.log.
+The specific modules that failed, and why, are listed in brz.log.

=== modified file 'breezy/tests/__init__.py'
--- breezy/tests/__init__.py	2019-06-16 01:03:51 +0000
+++ breezy/tests/__init__.py	2019-06-16 20:07:06 +0000
@@ -155,9 +155,9 @@
     'BZREMAIL': None,  # may still be present in the environment
     'EMAIL': '[e-mail]',  # set EMAIL as brz does not guess
     'BRZ_PROGRESS_BAR': None,
-    # This should trap leaks to ~/.brz.log. This occurs when tests use TestCase
-    # as a base class instead of TestCaseInTempDir. Tests inheriting from
-    # TestCase should not use disk resources, BRZ_LOG is one.
+    # Trap leaks to $XDG_CACHE_HOME/breezy/brz.log. This occurs when tests use
+    # TestCase as a base class instead of TestCaseInTempDir. Tests inheriting
+    # from TestCase should not use disk resources, BRZ_LOG is one.
     'BRZ_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
     'BRZ_PLUGIN_PATH': '-site',
     'BRZ_DISABLE_PLUGINS': None,
@@ -2684,7 +2684,7 @@
         """
         root = TestCaseWithMemoryTransport.TEST_ROOT
         try:
-            # Make sure we get a readable and accessible home for .brz.log
+            # Make sure we get a readable and accessible home for brz.log
             # and/or config files, and not fallback to weird defaults (see
             # http://pad.lv/825027).
             self.assertIs(None, os.environ.get('BRZ_HOME', None))

=== modified file 'breezy/tests/blackbox/test_version.py'
--- breezy/tests/blackbox/test_version.py	2018-11-11 04:08:32 +0000
+++ breezy/tests/blackbox/test_version.py	2019-06-16 20:07:06 +0000
@@ -56,7 +56,7 @@
         self.assertContainsRe(out, r"(?m)^  Python standard library:")
         self.assertContainsRe(out, r"(?m)^  breezy:")
         self.assertContainsRe(out, r"(?m)^  Breezy configuration:")
-        self.assertContainsRe(out, r'(?m)^  Breezy log file:.*\.brz\.log')
+        self.assertContainsRe(out, r'(?m)^  Breezy log file:.*[\\/]breezy[\\/]brz\.log')
 
     def test_version_short(self):
         self.permit_source_tree_branch_repo()
@@ -71,7 +71,7 @@
         # Even though trace._brz_log_filename variable
         # is used only to keep actual log filename
         # and changing this variable in selftest
-        # don't change main .brz.log location,
+        # don't change main brz.log location,
         # and therefore pretty safe,
         # but we run these tests in separate temp dir
         # with relative unicoded path
@@ -108,17 +108,19 @@
 
 class TestVersionBzrLogLocation(TestCaseInTempDir):
 
+    def default_log(self):
+        return os.path.join(os.environ['BRZ_HOME'], 'breezy', 'brz.log')
+
     def test_simple(self):
         brz_log = 'my.brz.log'
         self.overrideEnv('BRZ_LOG', brz_log)
-        default_log = os.path.join(os.environ['BRZ_HOME'], '.brz.log')
-        self.assertPathDoesNotExist([default_log, brz_log])
+        self.assertPathDoesNotExist([self.default_log(), brz_log])
         out = self.run_bzr_subprocess('version')[0]
         self.assertTrue(len(out) > 0)
         self.assertContainsRe(
             out, br"(?m)^  Breezy log file: " + brz_log.encode('ascii'))
-        self.assertPathDoesNotExist(default_log)
         self.assertPathExists(brz_log)
+        self.assertPathDoesNotExist(self.default_log())
 
     def test_dev_null(self):
         # This test uses a subprocess to cause the log opening logic to
@@ -128,13 +130,12 @@
         else:
             brz_log = '/dev/null'
         self.overrideEnv('BRZ_LOG', brz_log)
-        default_log = os.path.join(os.environ['BRZ_HOME'], '.brz.log')
-        self.assertPathDoesNotExist(default_log)
+        self.assertPathDoesNotExist(self.default_log())
         out = self.run_bzr_subprocess('version')[0]
         self.assertTrue(len(out) > 0)
         self.assertContainsRe(
             out, br"(?m)^  Breezy log file: " + brz_log.encode('ascii'))
-        self.assertPathDoesNotExist(default_log)
+        self.assertPathDoesNotExist(self.default_log())
 
     def test_unicode_brz_log(self):
         uni_val = u"\xa7"
@@ -145,7 +146,6 @@
             self.skipTest(
                 "Test string %r unrepresentable in user encoding %s" % (
                     uni_val, enc))
-        self.overrideEnv('BRZ_HOME', self.test_base_dir)
         brz_log = os.path.join(self.test_base_dir, uni_val)
         if PY3:
             self.overrideEnv("BRZ_LOG", brz_log)

=== modified file 'breezy/trace.py'
--- breezy/trace.py	2018-11-12 01:41:38 +0000
+++ breezy/trace.py	2019-06-16 20:07:06 +0000
@@ -23,11 +23,11 @@
 Messages are classified by severity levels: critical, error, warning, info,
 and debug.
 
-They can be sent to two places: to stderr, and to ~/.brz.log.  For purposes
-such as running the test suite, they can also be redirected away from both of
-those two places to another location.
+They can be sent to two places: stderr, and `$XDG_CACHE_HOME/breezy/brz.log`.
+For purposes such as running the test suite, they can also be redirected away
+from both of those two places to another location.
 
-~/.brz.log gets all messages, and full tracebacks for uncaught exceptions.
+`brz.log` gets all messages, and full tracebacks for uncaught exceptions.
 This trace file is always in UTF-8, regardless of the user's default encoding,
 so that we can always rely on writing any message.
 
@@ -72,6 +72,7 @@
 
 lazy_import(globals(), """
 from breezy import (
+    bedding,
     debug,
     errors,
     osutils,
@@ -96,7 +97,7 @@
 # than push/pop_log_file.
 _trace_file = None
 
-# Absolute path for ~/.brz.log.  Not changed even if the log/trace output is
+# Absolute path for brz.log.  Not changed even if the log/trace output is
 # redirected elsewhere.  Used to show the location in --version.
 _brz_log_filename = None
 
@@ -206,20 +207,14 @@
     brz_log = osutils.path_from_environ('BRZ_LOG')
     if brz_log:
         return brz_log
-    home = osutils.path_from_environ('BRZ_HOME')
-    if home is None:
-        # GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
-        #                over what would be better. On windows, bug 240550
-        #                suggests LOCALAPPDATA be used instead.
-        home = osutils._get_home_dir()
-    return os.path.join(home, '.brz.log')
+    return os.path.join(bedding.cache_dir(), 'brz.log')
 
 
 def _open_brz_log():
-    """Open the .brz.log trace file.
+    """Open the brz.log trace file.
 
     If the log is more than a particular length, the old file is renamed to
-    .brz.log.old and a new file is started.  Otherwise, we append to the
+    brz.log.old and a new file is started.  Otherwise, we append to the
     existing file.
 
     This sets the global _brz_log_filename.
@@ -280,7 +275,7 @@
 
 
 def enable_default_logging():
-    """Configure default logging: messages to stderr and debug to .brz.log
+    """Configure default logging: messages to stderr and debug to brz.log
 
     This should only be called once per process.
 
@@ -490,13 +485,13 @@
 
 
 def report_exception(exc_info, err_file):
-    """Report an exception to err_file (typically stderr) and to .brz.log.
+    """Report an exception to err_file (typically stderr) and to brz.log.
 
     This will show either a full traceback or a short message as appropriate.
 
     :return: The appropriate exit code for this error.
     """
-    # Log the full traceback to ~/.brz.log
+    # Log the full traceback to brz.log
     log_exception_quietly()
     if 'error' in debug.debug_flags:
         print_exception(exc_info, err_file)

=== modified file 'breezy/transport/log.py'
--- breezy/transport/log.py	2018-11-18 19:48:57 +0000
+++ breezy/transport/log.py	2019-06-16 20:07:06 +0000
@@ -14,7 +14,7 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-"""Transport decorator that logs transport operations to .brz.log."""
+"""Transport decorator that logs transport operations to brz.log."""
 
 from __future__ import absolute_import
 
@@ -29,7 +29,7 @@
 
 
 class TransportLogDecorator(decorator.TransportDecorator):
-    """Decorator for Transports that logs interesting operations to .brz.log.
+    """Decorator for Transports that logs interesting operations to brz.log.
 
     In general we want to log things that usually take a network round trip
     and may be slow.

=== modified file 'doc/developers/apport.txt'
--- doc/developers/apport.txt	2019-02-15 17:41:17 +0000
+++ doc/developers/apport.txt	2019-06-16 20:07:06 +0000
@@ -59,7 +59,7 @@
   because sometimes they are in fact bugs.  Then the user can attach the
   apport report later if they decide to file a bug.  There may be quite a
   lot of them so we might need to limit the number that are stored, or do
-  this when a debug flag is set.  At the moment they go into .bzr.log and
+  this when a debug flag is set.  At the moment they go into bzr.log and
   that's probably ok to start with.
 
 * Raising an error from the breakin debugger should cause this to fire.
@@ -69,7 +69,7 @@
   longwinded than our current output and might make the traceback scroll
   off the screen.
 
-* Automatically trace messages (ie from .bzr.log) in the report.  We could
+* Automatically trace messages (ie from bzr.log) in the report.  We could
   just include the whole file, but it may be long, and including the whole
   thing has a greater risk of including sensitive data.
 

=== modified file 'doc/developers/authentication-ring.txt'
--- doc/developers/authentication-ring.txt	2017-07-30 16:59:50 +0000
+++ doc/developers/authentication-ring.txt	2019-06-16 20:07:06 +0000
@@ -365,7 +365,7 @@
 * As this specification proposes a matching between some credentials
   definitions and real URLs, the implementation provides an optional UI
   feedback about which credential definition is used. Using ``-Dauth`` will
-  output some traces in the ``.bzr.log`` file metionning the sections
+  output some traces in the ``brz.log`` file metionning the sections
   used. This allows the user to validate his definitions.
 
 Questions and Answers

=== modified file 'doc/developers/integration.txt'
--- doc/developers/integration.txt	2017-11-11 12:51:45 +0000
+++ doc/developers/integration.txt	2019-06-16 20:07:06 +0000
@@ -5,7 +5,7 @@
 This document provides some general observations on integrating with
 Breezy and some recipes for typical tasks.  It is intended to be useful to
 someone developing either a plugin or some other piece of software that
-integrates with bzr.  If you want to know about a topic that's not covered
+integrates with brz.  If you want to know about a topic that's not covered
 here, just ask us.
 
 
@@ -14,50 +14,37 @@
 Starting with breezy
 ====================
 
-Within bzr
+Within brz
 ----------
 
-When using breezy within the ``bzr`` program (for instance as a bzr
+When using breezy within the ``brz`` program (for instance as a brz
 plugin), breezy's global state is already available for use.
 
-From outside bzr
+From outside brz
 ----------------
 
-To use breezy outside of ``bzr`` some global state needs to be setup.
+To use breezy outside of ``brz`` some global state needs to be setup.
 breezy needs ways to handle user input, passwords, a place to emit
 progress bars, logging setup appropriately for your program. The easiest
-way to set all this up in the same fashion ``bzr`` does is to call
-``breezy.initialize``. 
+way to set all this up in the same fashion ``brz`` does is to call
+``breezy.initialize``.
 
 This returns a context manager within which breezy functions will work
-correctly. See the pydoc for ``breezy.initialize`` for more information. 
+correctly. See the pydoc for ``breezy.initialize`` for more information.
 (You can get away without entering the context manager, because the setup
 work happens directly from ``initialize``.)
 
-In Python 2.4 the ``with`` keyword is not supported and
-so you need to use the context manager manually::
-
-  # This sets up your ~/.bzr.log, ui factory and so on and so forth. It is
-  # not safe to use as a doctest.
-  library_state = breezy.initialize()
-  library_state.__enter__()
-  try:
-      pass
-      # do stuff here
-  finally:
-      library_state.__exit__(None, None, None)
-
-
-Running bzr commands
+
+Running brz commands
 ====================
 
 To run command-line commands in-process::
 
   from breezy.commands import get_command
-  
+
   cmd = get_command('version')
   cmd.run([])
-  
+
 This will send output through the current UIFactory; you can redirect this
 elsewhere through the parameters to `breezy.initialize`.
 
@@ -69,7 +56,7 @@
 is loaded from the workingtree.py file, eg::
 
   from breezy import workingtree
-  wt = workingtree.WorkingTree.open('/home/jebw/bzrtest')
+  wt = workingtree.WorkingTree.open('/home/jebw/brztest')
 
 
 This gives us a WorkingTree object, which has various methods spread over
@@ -114,17 +101,17 @@
 Adding Files
 ------------
 
-If you want to add files the same way ``bzr add`` does, you can use
+If you want to add files the same way ``brz add`` does, you can use
 MutableTree.smart_add.  By default, this is recursive. Paths can either be
 absolute or relative to the workingtree::
 
   wt.smart_add(['dir1/filea.txt', 'fileb.txt',
-                '/home/jebw/bzrtesttree/filec.txt'])
+                '/home/jebw/brztesttree/filec.txt'])
 
 
 For more precise control over which files to add, use MutableTree.add::
 
-  wt.add(['dir1/filea.txt', 'fileb.txt', '/home/jebw/bzrtesttree/filec.txt'])
+  wt.add(['dir1/filea.txt', 'fileb.txt', '/home/jebw/brztesttree/filec.txt'])
 
 
 Removing Files
@@ -241,7 +228,7 @@
 
   from breezy import branch
 
-  b = branch.Branch.open('/home/jebw/bzrtest')
+  b = branch.Branch.open('/home/jebw/brztest')
 
 
 Branching from an existing branch
@@ -249,14 +236,14 @@
 
 To branch you create a branch object representing the branch you are
 branching from, and supply a path/url to the new branch location.
-The following code clones the bzr.dev branch (the latest copy of the Breezy
+The following code clones the brz trunk branch (the latest copy of the Breezy
 source code) - be warned it has to download 60meg so takes a while to run
 with no feedback::
 
   from breezy import branch
 
-  b = branch.Branch.open('http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev')
-  nb = b.controldir.sprout('/tmp/newBzrBranch').open_branch()
+  b = branch.Branch.open('bzr+ssh://bazaar.launchpad.net/+branch/brz/')
+  nb = b.controldir.sprout('/tmp/newBrzBzranch').open_branch()
 
 
 This provides no feedback, since Breezy automatically uses the 'silent' UI.
@@ -271,7 +258,7 @@
   from breezy import branch
 
   b1 = branch.Branch.open('file:///home/user/mybranch')
-  b2 = branch.Branch.open('http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev')
+  b2 = branch.Branch.open('bzr+ssh://bazaar.launchpad.net/+branch/brz/')
   b1.push(b2)
 
 
@@ -295,12 +282,12 @@
   from breezy import bzrdir
 
   accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch('http:URL')
-  source.create_checkout('/tmp/newBzrCheckout', None, True, accelerator_tree)
+  source.create_checkout('/tmp/newBrzCheckout', None, True, accelerator_tree)
 
 
 To make a heavyweight checkout, change the last line to::
 
-  source.create_checkout('/tmp/newBzrCheckout', None, False, accelerator_tree
+  source.create_checkout('/tmp/newBrzCheckout', None, False, accelerator_tree
 
 
 History Operations

=== modified file 'doc/developers/profiling.txt'
--- doc/developers/profiling.txt	2017-11-11 12:51:45 +0000
+++ doc/developers/profiling.txt	2019-06-16 20:07:06 +0000
@@ -49,7 +49,7 @@
 identifying unnecessary lock traffic.  This is activated by the ``-Dlock``
 global option.
 
-This writes messages into ``~/.brz.log``.
+This writes messages into ``$XDG_CACHE_HOME/breeezy/brz.log``.
 At present this only logs actions relating to the on-disk lockdir.  It
 doesn't describe actions on in-memory lock counters, or OS locks (which
 are used for dirstate.)