Skip to content

[lldb][docs] Update reference to test directory location #71081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 2, 2023

Conversation

chelcassanova
Copy link
Contributor

The instructions for running single tests in the LLDB test suite used an older directory structure from before the LLVM project became a monorepo. This commit updates the references to these directories.

The instructions for running single tests in the LLDB test suite used
an older directory structure from before the LLVM project became a
monorepo. This commit updates the references to these directories.
@llvmbot
Copy link
Member

llvmbot commented Nov 2, 2023

@llvm/pr-subscribers-lldb

Author: Chelsea Cassanova (chelcassanova)

Changes

The instructions for running single tests in the LLDB test suite used an older directory structure from before the LLVM project became a monorepo. This commit updates the references to these directories.


Full diff: https://github.com/llvm/llvm-project/pull/71081.diff

1 Files Affected:

  • (modified) lldb/docs/resources/test.rst (+3-3)
diff --git a/lldb/docs/resources/test.rst b/lldb/docs/resources/test.rst
index 3c9e24dde8fd454..52757864539ead5 100644
--- a/lldb/docs/resources/test.rst
+++ b/lldb/docs/resources/test.rst
@@ -483,7 +483,7 @@ run as part of a test suite.
 
 ::
 
-   $ ./bin/llvm-lit -sv tools/lldb/test --filter <test>
+   $ ./bin/llvm-lit -sv <llvm-project-root>/lldb/test --filter <test>
 
 
 Because lit automatically scans a directory for tests, it's also possible to
@@ -491,7 +491,7 @@ pass a subdirectory to run a specific subset of the tests.
 
 ::
 
-   $ ./bin/llvm-lit -sv tools/lldb/test/Shell/Commands/CommandScriptImmediateOutput
+   $ ./bin/llvm-lit -sv <llvm-project-root>/lldb/test/Shell/Commands/CommandScriptImmediateOutput
 
 
 For the SB API tests it is possible to forward arguments to ``dotest.py`` by
@@ -499,7 +499,7 @@ passing ``--param`` to lit and setting a value for ``dotest-args``.
 
 ::
 
-   $ ./bin/llvm-lit -sv tools/lldb/test --param dotest-args='-C gcc'
+   $ ./bin/llvm-lit -sv <llvm-project-root>/lldb/test --param dotest-args='-C gcc'
 
 
 Below is an overview of running individual test in the unit and API test suites

Copy link
Collaborator

@DavidSpickett DavidSpickett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Copy link
Member

@JDevlieghere JDevlieghere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@chelcassanova chelcassanova merged commit d483abd into llvm:main Nov 2, 2023
@chelcassanova chelcassanova deleted the lldb-test-docs branch November 2, 2023 17:35
@medismailben
Copy link
Member

LGTM! Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants