[llvm] [llvm][Docs] Fix incorrect command linking compile_commands.json (PR #123412)

Wilfred Hughes via llvm-commits llvm-commits at lists.llvm.org
Fri Jan 17 14:12:27 PST 2025


https://github.com/Wilfred created https://github.com/llvm/llvm-project/pull/123412

This command is being run from the `llvm-project` directory, so it should use the current directory, not the parent directory.

>From 58f7664acf5106d44bd60ee7327b70a09f939e61 Mon Sep 17 00:00:00 2001
From: Wilfred Hughes <me at wilfred.me.uk>
Date: Fri, 17 Jan 2025 14:12:08 -0800
Subject: [PATCH] [llvm][Docs] Fix incorrect command linking
 compile_commands.json

This command is being run from the `llvm-project` directory, so it should use the current directory, not the parent directory.
---
 llvm/docs/MyFirstTypoFix.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/llvm/docs/MyFirstTypoFix.rst b/llvm/docs/MyFirstTypoFix.rst
index 733b3eac141f27..f5930a7cab9262 100644
--- a/llvm/docs/MyFirstTypoFix.rst
+++ b/llvm/docs/MyFirstTypoFix.rst
@@ -164,7 +164,7 @@ into ``llvm-project/``:
 
 .. code:: console
 
-   $ ln -s build/compile_commands.json ../
+   $ ln -s build/compile_commands.json ./
 
 (This isn't strictly necessary for building and testing, but allows
 tools like clang-tidy, clang-query, and clangd to work in your source



More information about the llvm-commits mailing list