RBTools 5.2.1__tar.gz → 5.3__tar.gz

{rbtools-5.2.1 → rbtools-5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RBTools
-Version: 5.2.1
+Version: 5.3
 Summary: Command line tools and API for working with code and document reviews on Review Board
 Author-email: "Beanbag, Inc." <questions@beanbaginc.com>
 License: MIT

{rbtools-5.2.1 → rbtools-5.3}/RBTools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RBTools
-Version: 5.2.1
+Version: 5.3
 Summary: Command line tools and API for working with code and document reviews on Review Board
 Author-email: "Beanbag, Inc." <questions@beanbaginc.com>
 License: MIT

{rbtools-5.2.1 → rbtools-5.3}/RBTools.egg-info/SOURCES.txt

@@ -43,6 +43,7 @@ docs/rbtools/conf.py
 docs/rbtools/glossary.rst
 docs/rbtools/index.rst
 docs/rbtools/installation.rst
+docs/rbtools/redirects.json
 docs/rbtools/_ext/__init__.py
 docs/rbtools/_ext/rbt_commands.py
 docs/rbtools/api/index.rst
@@ -77,11 +78,11 @@ docs/rbtools/rbt/configuration/index.rst
 docs/rbtools/rbt/configuration/repositories.rst
 docs/rbtools/rbt/configuration/tfs.rst
 docs/rbtools/rbt/configuration/users.rst
+docs/rbtools/workflows/clearcase.rst
 docs/rbtools/workflows/git.rst
 docs/rbtools/workflows/index.rst
 docs/rbtools/workflows/perforce.rst
 docs/rbtools/workflows/sos.rst
-docs/rbtools/workflows/versionvault.rst
 docs/releasenotes/0.2-beta-1.rst
 docs/releasenotes/0.2-beta-2.rst
 docs/releasenotes/0.2-rc-1.rst
@@ -136,6 +137,7 @@ docs/releasenotes/5.1.1.rst
 docs/releasenotes/5.1.rst
 docs/releasenotes/5.2.1.rst
 docs/releasenotes/5.2.rst
+docs/releasenotes/5.3.rst
 docs/releasenotes/Makefile
 docs/releasenotes/conf.py
 docs/releasenotes/index.rst

{rbtools-5.2.1 → rbtools-5.3}/RBTools.egg-info/entry_points.txt

@@ -9,6 +9,7 @@ clear-cache = rbtools.commands.clearcache:ClearCache
 close = rbtools.commands.close:Close
 diff = rbtools.commands.diff:Diff
 info = rbtools.commands.info:Info
+install = rbtools.commands.install:Install
 land = rbtools.commands.land:Land
 list-repo-types = rbtools.commands.list_repo_types:ListRepoTypes
 login = rbtools.commands.login:Login

rbtools-5.3/contrib/installers/windows/wix/files/rbt

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+python_dir="`dirname "$0"`/../Python"
+
+"${python_dir}/python.exe" "${python_dir}/Scripts/rbt.exe" $*

rbtools-5.3/contrib/installers/windows/wix/files/rbt.cmd

@@ -0,0 +1 @@
+@"%~dp0..\Python\python.exe" "%~dp0..\Python\Scripts\rbt.exe" %*

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/conf.py

@@ -46,6 +46,7 @@ extensions = [
     'sphinx.ext.linkcode',
     'sphinx_tabs.tabs',
     'beanbag_docutils.sphinx.ext.autodoc_utils',
+    'beanbag_docutils.sphinx.ext.collect_files',
     'beanbag_docutils.sphinx.ext.extlinks',
     'beanbag_docutils.sphinx.ext.http_role',
     'beanbag_docutils.sphinx.ext.ref_utils',
@@ -296,3 +297,8 @@ def linkcode_resolve(domain, info):
                                    github_org_id='reviewboard',
                                    github_repo_id='rbtools',
                                    branch=git_branch)
+
+
+collect_file_patterns = [
+    'redirects.json',
+]

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/index.rst

@@ -146,7 +146,7 @@ common workflows to help you get started:
 
 * :ref:`rbtools-workflow-sos`
 * :ref:`rbtools-workflow-git`
-* :ref:`rbtools-workflow-versionvault`
+* :ref:`rbtools-workflow-clearcase`
 * :ref:`rbtools-workflow-perforce`
 
 

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/rbt/commands/install.rst

@@ -8,8 +8,10 @@ install
 interact with a repository.
 
 As of this release, the only dependency supported is ``tfs``, needed for
-:rbintegration:`Microsoft Team Foundation Server <tfs>` repositories. This can
-be installed. See :ref:`rbtools-tfs` for more information.
+:rbintegration:`Azure DevOps Server / TFS <azure-devops-server>` and
+:rbintegration:`Azure DevOps Services <azure-devops-services>` TFVC
+repositories. This can be installed. See :ref:`rbtools-tfs` for more
+information.
 
 
 .. rbt-command-usage::

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/rbt/commands/post.rst

@@ -225,17 +225,21 @@ which specifies the remote branch name. For example:
 
 .. _rbt-post-clearcase:
 
-ClearCase and VersionVault
---------------------------
+ClearCase
+---------
 
 .. versionchanged:: 3.0
-   As of Version 3.0, RBTools supports both the legacy "ClearCase" repository
-   type, as well as the new "VersionVault" type which is a part of `Power
-   Pack`_. VersionVault can be used with both IBM ClearCase as well as HCL
-   VersionVault, and is the recommended implementation to use.
+   As of Version 3.0, RBTools supports both the legacy "ClearCase (legacy)"
+   repository type, as well as the modern "ClearCase" type which is a part of
+   `Power Pack`_.
+
+   The modern type can be used with both IBM ClearCase as well as HCL
+   ClearCase, and is the recommended implementation to use. Note that in
+   Power Pack 5.3 and lower, the modern repository type is listed as
+   "VersionVault / ClearCase" and the legacy type is "ClearCase".
 
 :command:`rbt post` provides support for posting changes using IBM ClearCase or
-HCL VersionVault repositories. There are several different modes which can be
+HCL ClearCase repositories. There are several different modes which can be
 used depending on how you've organized your repository. Changes must be posted
 from within a snapshot or dynamic view.
 
@@ -301,23 +305,23 @@ Multiple files can be posted by adding additional file/revision pairs:
 .. note::
 
    There are two ways that ClearCase repositories may be configured on the
-   Review Board server. If the repository is using the community-driven
-   ClearCase backed, review requests may only contain changes from a single
-   VOB. If the repository uses the newer VersionVault backend, changes may span
-   across multiple VOBs.
+   Review Board server. If the repository is using the legacy, community-driven
+   ClearCase backend, review requests may only contain changes from a single
+   VOB. If the repository uses the modern Power Pack-based backend, changes
+   may span across multiple VOBs.
 
 .. _`Power Pack`: https://www.reviewboard.org/powerpack
 
 
 .. _rbt-post-sos:
 
-Cliosoft SOS
+Keysight SOS
 ------------
 
 .. versionadded:: 3.1
 
 :command:`rbt post` provides support for posting changes using
-`Cliosoft SOS`_ 7.20 or higher. It supports posting changelists (recommended)
+`Keysight SOS`_ 7.20 or higher. It supports posting changelists (recommended)
 or selections.
 
 See :ref:`rbtools-workflow-sos` for a detailed guide.
@@ -370,7 +374,7 @@ with this. Examples include:
    $ rbt post -r 123 "select:-scm -sor -sunm"
 
 
-.. _Cliosoft SOS: https://www.cliosoft.com/products/sos/
+.. _Keysight SOS: https://www.keysight.com/ca/en/products/software/pathwave-design-software/design-data-and-ip-management/design-data-management-sos.html
 
 
 .. index:: post-commit review

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/rbt/configuration/repositories.rst

@@ -490,7 +490,7 @@ Valid repository types include:
 * ``plastic``
 * ``sos``
 * ``svn``
-* ``tfs``
+* ``tfs`` (TFVC repositories on Azure DevOps / TFS)
 
 Example:
 

rbtools-5.3/docs/rbtools/rbt/configuration/tfs.rst

@@ -0,0 +1,74 @@
+.. _rbtools-tfs:
+
+===================================================
+Azure DevOps / Team Foundation Server Configuration
+===================================================
+
+RBTools supports posting changes against TFVC repositories hosted on Azure
+DevOps Server / Team Foundation Server and Azure DevOps Services. Depending
+on what version of Visual Studio (or other development environment) you're
+using, there are different requirements for supporting Azure DevOps / Team
+Foundation Server TFVC repositories. These aren't needed when working with
+Git repositories hosted on Azure DevOps / TFS.
+
+The table below summarizes the three different methods and the different
+features which are available under each.
+
+Note that if you're running VS2017 or higher, the only option available is the
+built-in :command:`tf.exe` method.
+
++---------------------------+----------------+------------------+--------------------------+
+|                           | VS2017+ tf.exe | rb-tfs adaptor   | Team Explorer Everywhere |
++===========================+================+==================+==========================+
+| OS support                | Windows        | All              | All                      |
++---------------------------+----------------+------------------+--------------------------+
+| Visual Studio versions    | 2017+          | 2010, 2013, 2015 | 2010, 2013, 2015         |
++---------------------------+----------------+------------------+--------------------------+
+| Posting pending changes   | Yes            | Yes              | Yes                      |
++---------------------------+----------------+------------------+--------------------------+
+| Posting committed changes | No             | Yes              | No                       |
++---------------------------+----------------+------------------+--------------------------+
+| Posting shelvesets        | No             | Yes              | No                       |
++---------------------------+----------------+------------------+--------------------------+
+
+
+VS2017+ tf.exe
+-------------
+
+Visual Studio 2017 and higher include a command-line tool, :command:`tf.exe`,
+which includes enough support for RBTools to post pending changes to Review
+Board. Committed changes can be posted, but only through the web UI, and
+shelvesets are not supported.
+
+Due to changes in Microsoft's data storage formats, if you're using VS2017+, the
+other options (the rb-tfs adaptor and Team Explorer Everywhere) will not work.
+
+This method requires GNU diff but no other installation.
+
+
+.. _rb-tfs:
+
+rb-tfs adaptor
+--------------
+
+When using Visual Studio 2010 through 2015, the Team Explorer Everywhere tools,
+or the TFS extensions for Eclipse, we provide a custom adaptor which supports
+posting pending, committed, or shelved changes.
+
+To install the rb-tfs adaptor, run:
+
+.. code-block:: console
+
+     $ rbt install tfs
+
+
+Team Explorer Everywhere
+------------------------
+
+If you have the `Team Explorer Everywhere`_ command-line tools installed,
+RBTools can use that for posting committed changes. In all cases where you
+might use this, the :ref:`rb-tfs` adaptor is faster and supports more features.
+Team Explorer Everywhere works with Visual Studio 2010 through 2015.
+
+.. _`Team Explorer Everywhere`:
+   https://github.com/microsoft/team-explorer-everywhere

rbtools-5.3/docs/rbtools/redirects.json

@@ -0,0 +1,3 @@
+{
+    "workflows/versionvault": "workflows/clearcase"
+}

rbtools-5.2.1/docs/rbtools/workflows/versionvault.rst → rbtools-5.3/docs/rbtools/workflows/clearcase.rst

@@ -1,33 +1,35 @@
+.. _rbtools-workflow-clearcase:
 .. _rbtools-workflow-versionvault:
 
-=====================================================
-Using RBTools with HCL VersionVault and IBM ClearCase
-=====================================================
+==================================================
+Using RBTools with HCL ClearCase and IBM ClearCase
+==================================================
 
-This guide covers the various ways to use RBTools with `HCL VersionVault`_ or
+This guide covers the various ways to use RBTools with `HCL ClearCase`_ or
 `IBM ClearCase`_. You can post changes using both Base ClearCase or UCM
 workflows.
 
 A typical workflow looks like this:
 
 1. :ref:`Create your change for the review request
-   <rbtools-workflow-versionvault-step1>`
+   <rbtools-workflow-clearcase-step1>`
 
-2. :ref:`Post your change for review <rbtools-workflow-versionvault-step2>`
+2. :ref:`Post your change for review <rbtools-workflow-clearcase-step2>`
 
 3. :ref:`Make changes based on feedback and re-port for review
-   <rbtools-workflow-versionvault-step3>`
+   <rbtools-workflow-clearcase-step3>`
 
 4. :ref:`Finish your code by checking in or delivering your activity
-   <rbtools-workflow-versionvault-step4>`
+   <rbtools-workflow-clearcase-step4>`
 
-5. :ref:`Close your review request <rbtools-workflow-versionvault-step5>`
+5. :ref:`Close your review request <rbtools-workflow-clearcase-step5>`
 
 
-.. _HCL VersionVault: https://www.hcltechsw.com/versionvault
-.. _IBM ClearCase: https://www.ibm.com/products/rational-clearcase
+.. _HCL ClearCase: https://www.hcl-software.com/devops-code-clearcase
+.. _IBM ClearCase: https://www.ibm.com/products/devops-code-clearcase
 
 
+.. _rbtools-workflow-clearcase-step1:
 .. _rbtools-workflow-versionvault-step1:
 
 Step 1: Create your change
@@ -37,6 +39,7 @@ You'll be able to post a branch, label, activity, baseline, or stream
 representing the change you want to review.
 
 
+.. _rbtools-workflow-clearcase-step2:
 .. _rbtools-workflow-versionvault-step2:
 
 Step 2: Posting changes for review
@@ -145,6 +148,7 @@ Once you're done filling out fields on the review request, click
 :guilabel:`Publish` to send it out for review.
 
 
+.. _rbtools-workflow-clearcase-step3:
 .. _rbtools-workflow-versionvault-step3:
 
 Step 3: Update from reviewer feedback and re-post
@@ -181,6 +185,7 @@ Got some reviewer feedback to incorporate into your change? Easy.
    accepted.
 
 
+.. _rbtools-workflow-clearcase-step4:
 .. _rbtools-workflow-versionvault-step4:
 
 Step 4: Finish your code
@@ -191,6 +196,7 @@ change. This could involve checking in any checked-out files, or delivering
 your current UCM activity.
 
 
+.. _rbtools-workflow-clearcase-step5:
 .. _rbtools-workflow-versionvault-step5:
 
 Step 5: Close your review request
@@ -209,6 +215,7 @@ this in one of two ways:
    :ref:`documentation <rbt-close>`).
 
 
+.. _rbtools-workflow-clearcase-example:
 .. _rbtools-workflow-versionvault-example:
 
 Putting it all together

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/workflows/index.rst

@@ -12,7 +12,7 @@ RBTools Workflows
 
    sos
    git
-   versionvault
+   clearcase
    perforce
 
 

{rbtools-5.2.1 → rbtools-5.3}/docs/rbtools/workflows/sos.rst

@@ -1,10 +1,10 @@
 .. _rbtools-workflow-sos:
 
 ===============================
-Using RBTools With Cliosoft SOS
+Using RBTools With Keysight SOS
 ===============================
 
-This guide covers how you can use RBTools to post changes to `Cliosoft SOS`_
+This guide covers how you can use RBTools to post changes to `Keysight SOS`_
 7.20 or higher. We'll cover posting both selections and changelists (new in SOS
 7.20) for review.
 
@@ -36,7 +36,7 @@ We'll go over these concepts and then
    Changes that are already committed cannot currently be posted for review.
 
 
-.. _Cliosoft SOS: https://www.cliosoft.com/products/sos/
+.. _Keysight SOS: https://www.keysight.com/ca/en/products/software/pathwave-design-software/design-data-and-ip-management/design-data-management-sos.html
 
 
 .. _rbtools-workflow-sos-step1:

rbtools-5.3/docs/releasenotes/5.3.rst

@@ -0,0 +1,78 @@
+.. default-intersphinx:: rbt5.x rb-latest
+
+=========================
+RBTools 5.3 Release Notes
+=========================
+
+**Release date:** July 14, 2025
+
+
+Installation
+============
+
+Follow our :ref:`installation guide <rbtools-installation>` to install
+RBTools.
+
+To learn more, see:
+
+* `Documentation <https://www.reviewboard.org/docs/rbtools/5.x/>`_
+* `RBTools on PyPI <https://pypi.org/project/rbtools/>`_
+* `RBTools on GitHub <https://github.com/reviewboard/rbtools/>`_
+
+
+New Features
+============
+
+* Added support for newer versions of Azure DevOps Server / Team Foundation
+  Server.
+
+  RBTools can now work with modern versions of :command:`tf.exe` from
+  Visual Studio, making it easy to post your changes without maintaining
+  multiple copies of TFVC.
+
+  See the :ref:`rbtools-tfs` documentation for more information.
+
+* Renamed our Cliosoft SOS support to Keysight SOS.
+
+  Cliosoft SOS was purchased by Keysight, and is now `Keysight SOS`_.
+  RBTools now documents this as Keysight SOS and lists it in the list of
+  supported repository types.
+
+  See :ref:`rbtools-workflow-sos` to learn more about using Keysight SOS.
+
+
+.. _Keysight SOS: https://www.keysight.com/us/en/products/software/pathwave-design-software/design-data-and-ip-management/design-data-management-sos.html
+
+
+Bug Fixes
+=========
+
+Installation
+------------
+
+* Fixed an issue running the :ref:`rbt <rbt>` command after using the
+  :ref:`RBTools for Windows installer <rbtools-installer>`.
+
+* Added back support for the :rbtcommand:`rbt install` command, used to
+  install Azure DevOps Server / Team Foundation Server support.
+
+
+Azure DevOps Server / Team Foundation Server
+--------------------------------------------
+
+* Fixed parsing commit history containing Windows-style newlines.
+
+
+Git
+---
+
+* Fixed using :option:`rbt post --exclude` with filenames containing spaces.
+  (:bug:`5045`)
+
+
+Contributors
+============
+
+* Christian Hammond
+* David Trowbridge
+* Michelle Aubin

{rbtools-5.2.1 → rbtools-5.3}/docs/releasenotes/index.rst

@@ -11,6 +11,7 @@ RBTools Release Notes
 .. toctree::
    :maxdepth: 1
 
+   5.3
    5.2.1
    5.2
    5.1.1

{rbtools-5.2.1 → rbtools-5.3}/pyproject.toml

@@ -74,6 +74,7 @@ clear-cache = 'rbtools.commands.clearcache:ClearCache'
 close = 'rbtools.commands.close:Close'
 diff = 'rbtools.commands.diff:Diff'
 info = 'rbtools.commands.info:Info'
+install = 'rbtools.commands.install:Install'
 land = 'rbtools.commands.land:Land'
 list-repo-types = 'rbtools.commands.list_repo_types:ListRepoTypes'
 login = 'rbtools.commands.login:Login'

{rbtools-5.2.1 → rbtools-5.3}/rbtools/__init__.py

@@ -10,7 +10,7 @@ Beanbag Tools. They're largely used for packaging purposes.
 #:
 #: (Major, Minor, Micro, Patch, alpha/beta/rc/final, Release Number, Released)
 #:
-VERSION = (5, 2, 1, 0, 'final', 0, True)
+VERSION = (5, 3, 0, 0, 'final', 0, True)
 
 
 def get_version_string():

{rbtools-5.2.1 → rbtools-5.3}/rbtools/clients/clearcase.py

@@ -391,7 +391,7 @@ class ClearCaseClient(BaseSCMClient):
     """
 
     scmclient_id = 'clearcase'
-    name = 'VersionVault / ClearCase'
+    name = 'ClearCase'
 
     # Review Board versions that use the old names-based repositories/?tool=
     # API parameter also have a bug where a missing name could cause a

{rbtools-5.2.1 → rbtools-5.3}/rbtools/clients/git.py

@@ -1119,7 +1119,7 @@ class GitClient(BaseSCMClient):
             # of the line is the name of the file that has changed.
             changed_files = remove_filenames_matching_patterns(
                 filenames=(
-                    filename.split()[-1]
+                    filename.split('\t', 1)[1].rstrip('\n')
                     for filename in changed_files
                 ),
                 patterns=exclude_patterns,

{rbtools-5.2.1 → rbtools-5.3}/rbtools/clients/sos.py

@@ -1,7 +1,7 @@
-"""A client for Cliosoft SOS.
+"""A client for Keysight SOS (formerly Cliosoft SOS).
 
-`Cliosoft SOS <https://www.cliosoft.com/products/sos/>`_ is an Enterprise
-SCM focused on hardware design and configuration management.
+`Keysight SOS https://www.keysight.com/ca/en/products/software/pathwave-design-software/design-data-and-ip-management/design-data-management-sos.html`_
+is an Enterprise SCM focused on hardware design and configuration management.
 
 Version Added:
     3.1
@@ -217,10 +217,11 @@ class SOSChangeList(object):
 
 
 class SOSClient(BaseSCMClient):
-    """A client for Cliosoft SOS.
+    """A client for Keysight SOS.
 
-    `Cliosoft SOS <https://www.cliosoft.com/products/sos/>`_ is an Enterprise
-    SCM focused on hardware design and configuration management.
+    `Keysight SOS https://www.keysight.com/ca/en/products/software/pathwave-design-software/design-data-and-ip-management/design-data-management-sos.html`_
+    is an Enterprise SCM focused on hardware design and configuration
+    management.
 
     This implementation makes use of :command:`soscmd` to fetch information on
     repositories and generate suitable diffs.
@@ -230,12 +231,16 @@ class SOSClient(BaseSCMClient):
 
     This implementation is expected to be used with SOS 7.20 or higher.
 
+    Version Changed:
+        5.2.3:
+        Changed the ``name`` from ``Cliosoft SOS`` to ``Keysight SOS``.
+
     Version Added:
         3.1
     """
 
     scmclient_id = 'sos'
-    name = 'Cliosoft SOS'
+    name = 'Keysight SOS'
 
     requires_diff_tool = True
 

{rbtools-5.2.1 → rbtools-5.3}/rbtools/clients/tests/test_git.py

@@ -1,5 +1,7 @@
 """Unit tests for GitClient."""
 
+from __future__ import annotations
+
 import os
 import re
 import unittest
@@ -572,6 +574,45 @@ class GitClientTests(BaseGitClientTests):
                 'parent_diff': None,
             })
 
+    def test_diff_with_exclude_patterns_spaces_in_filename(self) -> None:
+        """Testing GitClient.diff with file exclusion and spaces in filename"""
+        client = self.build_client(needs_diff=True)
+        client.get_repository_info()
+        base_commit_id = self._git_get_head()
+
+        self._git_add_file_commit('included file.txt', FOO1, 'commit 1')
+        self._git_add_file_commit('excluded file.txt', FOO2, 'commit 2')
+        commit_id = self._git_get_head()
+
+        revisions = client.parse_revision_spec([])
+
+        self.assertEqual(
+            client.diff(revisions, include_files=[],
+                        exclude_patterns=['excluded file.txt']),
+            {
+                'commit_id': commit_id,
+                'base_commit_id': base_commit_id,
+                'diff': (
+                    b'diff --git a/included file.txt b/included file.txt\n'
+                    b'new file mode 100644\nindex '
+                    b'0000000000000000000000000000000000000000..'
+                    b'5e98e9540e1b741b5be24fcb33c40c1c8069c1fb\n'
+                    b'--- /dev/null\n'
+                    b'+++ b/included file.txt\t\n'
+                    b'@@ -0,0 +1,9 @@\n'
+                    b'+ARMA virumque cano, Troiae qui primus ab oris\n'
+                    b'+Italiam, fato profugus, Laviniaque venit\n'
+                    b'+litora, multum ille et terris iactatus et alto\n'
+                    b'+vi superum saevae memorem Iunonis ob iram;\n'
+                    b'+multa quoque et bello passus, dum conderet urbem,\n'
+                    b'+inferretque deos Latio, genus unde Latinum,\n'
+                    b'+Albanique patres, atque altae moenia Romae.\n'
+                    b'+Musa, mihi causas memora, quo numine laeso,\n'
+                    b'+\n'
+                ),
+                'parent_diff': None,
+            })
+
     def test_diff_exclude_in_subdir(self):
         """Testing GitClient.diff with file exclusion in a subdir"""
         client = self.build_client(needs_diff=True)