Merge pull request tahoe-lafs#921 from tahoe-lafs/3550.remove-start-s…

…top-restart-daemonize

remove start stop restart daemonize

Fixes: ticket:3550
Fixes: ticket:3523
Fixes: ticket:3524

docs/anonymity-configuration.rst

@@ -273,7 +273,7 @@ Then, do the following:
     [connections]
     tcp = tor
 
-* Launch the Tahoe server with ``tahoe start $NODEDIR``
+* Launch the Tahoe server with ``tahoe run $NODEDIR``
 
 The ``tub.port`` section will cause the Tahoe server to listen on PORT, but
 bind the listening socket to the loopback interface, which is not reachable
@@ -435,4 +435,3 @@ It is therefore important that your I2P router is sharing bandwidth with other
 routers, so that you can give back as you use I2P. This will never impair the
 performance of your Tahoe-LAFS node, because your I2P router will always
 prioritize your own traffic.
-

docs/configuration.rst

@@ -365,7 +365,7 @@ set the ``tub.location`` option described below.
     also generally reduced when operating in private mode.
 
     When False, any of the following configuration problems will cause
-    ``tahoe start`` to throw a PrivacyError instead of starting the node:
+    ``tahoe run`` to throw a PrivacyError instead of starting the node:
 
     * ``[node] tub.location`` contains any ``tcp:`` hints
 

docs/frontends/CLI.rst

@@ -85,7 +85,7 @@ Node Management
 
 "``tahoe create-node [NODEDIR]``" is the basic make-a-new-node
 command. It creates a new directory and populates it with files that
-will allow the "``tahoe start``" and related commands to use it later
+will allow the "``tahoe run``" and related commands to use it later
 on. ``tahoe create-node`` creates nodes that have client functionality
 (upload/download files), web API services (controlled by the
 '[node]web.port' configuration), and storage services (unless
@@ -94,8 +94,7 @@ on. ``tahoe create-node`` creates nodes that have client functionality
 NODEDIR defaults to ``~/.tahoe/`` , and newly-created nodes default to
 publishing a web server on port 3456 (limited to the loopback interface, at
 127.0.0.1, to restrict access to other programs on the same host). All of the
-other "``tahoe``" subcommands use corresponding defaults (with the exception
-that "``tahoe run``" defaults to running a node in the current directory).
+other "``tahoe``" subcommands use corresponding defaults.
 
 "``tahoe create-client [NODEDIR]``" creates a node with no storage service.
 That is, it behaves like "``tahoe create-node --no-storage [NODEDIR]``".
@@ -117,25 +116,6 @@ the same way on all platforms and logs to stdout. If you want to run
 the process as a daemon, it is recommended that you use your favourite
 daemonization tool.
 
-The now-deprecated "``tahoe start [NODEDIR]``" command will launch a
-previously-created node. It will launch the node into the background
-using ``tahoe daemonize`` (and internal-only command, not for user
-use). On some platforms (including Windows) this command is unable to
-run a daemon in the background; in that case it behaves in the same
-way as "``tahoe run``". ``tahoe start`` also monitors the logs for up
-to 5 seconds looking for either a succesful startup message or for
-early failure messages and produces an appropriate exit code.  You are
-encouraged to use ``tahoe run`` along with your favourite
-daemonization tool instead of this. ``tahoe start`` is maintained for
-backwards compatibility of users already using it; new scripts should
-depend on ``tahoe run``.
-
-"``tahoe stop [NODEDIR]``" will shut down a running node. "``tahoe
-restart [NODEDIR]``" will stop and then restart a running
-node. Similar to above, you should use ``tahoe run`` instead alongside
-your favourite daemonization tool.
-
-
 File Store Manipulation
 =======================
 

docs/frontends/webapi.rst

@@ -2145,7 +2145,7 @@ you could do the following::
  tahoe debug dump-cap URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861
  -> storage index: whpepioyrnff7orecjolvbudeu
  echo "whpepioyrnff7orecjolvbudeu my puppy told me to" >>$NODEDIR/access.blacklist
- tahoe restart $NODEDIR
+ # ... restart the node to re-read configuration ...
  tahoe get URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861
  -> error, 403 Access Prohibited: my puppy told me to
 

docs/logging.rst

@@ -128,10 +128,9 @@ provided in ``misc/incident-gatherer/support_classifiers.py`` . There is
 roughly one category for each ``log.WEIRD``-or-higher level event in the
 Tahoe source code.
 
-The incident gatherer is created with the "``flogtool
-create-incident-gatherer WORKDIR``" command, and started with "``tahoe
-start``". The generated "``gatherer.tac``" file should be modified to add
-classifier functions.
+The incident gatherer is created with the "``flogtool create-incident-gatherer
+WORKDIR``" command, and started with "``tahoe run``". The generated
+"``gatherer.tac``" file should be modified to add classifier functions.
 
 The incident gatherer writes incident names (which are simply the relative
 pathname of the ``incident-\*.flog.bz2`` file) into ``classified/CATEGORY``.
@@ -175,7 +174,7 @@ things that happened on multiple machines (such as comparing a client node
 making a request with the storage servers that respond to that request).
 
 Create the Log Gatherer with the "``flogtool create-gatherer WORKDIR``"
-command, and start it with "``tahoe start``". Then copy the contents of the
+command, and start it with "``twistd -ny gatherer.tac``". Then copy the contents of the
 ``log_gatherer.furl`` file it creates into the ``BASEDIR/tahoe.cfg`` file
 (under the key ``log_gatherer.furl`` of the section ``[node]``) of all nodes
 that should be sending it log events. (See :doc:`configuration`)

docs/running.rst

@@ -81,9 +81,7 @@ does not offer its disk space to other nodes. To configure other behavior,
 use “``tahoe create-node``” or see :doc:`configuration`.
 
 The “``tahoe run``” command above will run the node in the foreground.
-On Unix, you can run it in the background instead by using the
-“``tahoe start``” command. To stop a node started in this way, use
-“``tahoe stop``”. ``tahoe --help`` gives a summary of all commands.
+``tahoe --help`` gives a summary of all commands.
 
 
 Running a Server or Introducer
@@ -99,12 +97,10 @@ and ``--location`` arguments.
 To construct an introducer, create a new base directory for it (the name
 of the directory is up to you), ``cd`` into it, and run “``tahoe
 create-introducer --hostname=example.net .``” (but using the hostname of
-your VPS). Now run the introducer using “``tahoe start .``”. After it
+your VPS). Now run the introducer using “``tahoe run .``”. After it
 starts, it will write a file named ``introducer.furl`` into the
 ``private/`` subdirectory of that base directory. This file contains the
 URL the other nodes must use in order to connect to this introducer.
-(Note that “``tahoe run .``” doesn't work for introducers, this is a
-known issue: `#937`_.)
 
 You can distribute your Introducer fURL securely to new clients by using
 the ``tahoe invite`` command. This will prepare some JSON to send to the

integration/conftest.py

@@ -201,9 +201,8 @@ def introducer(reactor, temp_dir, flog_gatherer, request):
     with open(join(intro_dir, 'tahoe.cfg'), 'w') as f:
         f.write(config)
 
-    # on windows, "tahoe start" means: run forever in the foreground,
-    # but on linux it means daemonize. "tahoe run" is consistent
-    # between platforms.
+    # "tahoe run" is consistent across Linux/macOS/Windows, unlike the old
+    # "start" command.
     protocol = _MagicTextProtocol('introducer running')
     transport = _tahoe_runner_optional_coverage(
         protocol,
@@ -278,9 +277,8 @@ def tor_introducer(reactor, temp_dir, flog_gatherer, request):
     with open(join(intro_dir, 'tahoe.cfg'), 'w') as f:
         f.write(config)
 
-    # on windows, "tahoe start" means: run forever in the foreground,
-    # but on linux it means daemonize. "tahoe run" is consistent
-    # between platforms.
+    # "tahoe run" is consistent across Linux/macOS/Windows, unlike the old
+    # "start" command.
     protocol = _MagicTextProtocol('introducer running')
     transport = _tahoe_runner_optional_coverage(
         protocol,

integration/util.py

@@ -189,10 +189,8 @@ def _run_node(reactor, node_dir, request, magic_text):
         magic_text = "client running"
     protocol = _MagicTextProtocol(magic_text)
 
-    # on windows, "tahoe start" means: run forever in the foreground,
-    # but on linux it means daemonize. "tahoe run" is consistent
-    # between platforms.
-
+    # "tahoe run" is consistent across Linux/macOS/Windows, unlike the old
+    # "start" command.
     transport = _tahoe_runner_optional_coverage(
         protocol,
         reactor,

newsfragments/3550.removed

@@ -0,0 +1 @@
+The deprecated ``tahoe`` start, restart, stop, and daemonize sub-commands have been removed.

src/allmydata/scripts/common.py

@@ -37,7 +37,7 @@ def __init__(self):
         super(BaseOptions, self).__init__()
         self.command_name = os.path.basename(sys.argv[0])
 
-    # Only allow "tahoe --version", not e.g. "tahoe start --version"
+    # Only allow "tahoe --version", not e.g. "tahoe <cmd> --version"
     def opt_version(self):
         raise usage.UsageError("--version not allowed on subcommands")