From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pl1-f173.google.com (mail-pl1-f173.google.com [209.85.214.173]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A003D211706 for ; Tue, 7 Oct 2025 08:32:38 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.173 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1759825961; cv=none; b=SIp7uW0VBLJSs86zWVM1YpToU9eHbrOTHiFQNPdwnr4eHJLdvgF3SdM8Dp5mkArwpjk102rgkiuLwsot5pWQh5J1S96fVbEELtWHJeJX8doEwljPu3p0MhKZqcBTX91nLFX2x99h9aK0BHd9R4fD63Ri5iz8fAyq12L66yz2BUs= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1759825961; c=relaxed/simple; bh=UyXS0YiulfoICjWKVbZLAuV+X0gt4aJvE3oK8qyJ30E=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=HImauGoa0l9hcMvw+btc6Wi5uADJDU2AjJzZZBDnog5eaeL0pYeJJx3B5GdyDDZxDWaMPDF5ALf85mLhaCyYp5fR2YKLVrEq1vpQGBWJB1unAK3o6tHSAqxO3qJAx2rlQMLPKBBon25UHpXRtDa0BP3SEvaRJt1+zQHsLMW1pak= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=ix7xjlYz; arc=none smtp.client-ip=209.85.214.173 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="ix7xjlYz" Received: by mail-pl1-f173.google.com with SMTP id d9443c01a7336-27ee41e074dso64540565ad.1 for ; Tue, 07 Oct 2025 01:32:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1759825958; x=1760430758; darn=lists.linux.dev; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=HprILVmlCINZEM+NQvrClrUcjHEMUlllXqO7BPuLx90=; b=ix7xjlYzUkICjGX8F5TEFdPZm5P1W5iem/v6zcdyTFlpn9DaI3DFMGQ8Y6Z6AkfRBL 1BB6yt0LKHwCtvEe746w2zs7dJBrjUVHTP9W/6/+zjvOMJ1VRZMhiA30hpryVdYf3Nnq wYTPlhp9UPNMKIwP8wwxv4TdMF6fLkh/pjgNU05JWi+Mtki6oLPAzlsCJgS0PFJBI4mX z0mVKxia+ot8UKpXip9UVB/x0ipT5EpnoVhC1LifxLuxYiIxz638jDBkYGQp/xyYrFFO NBhfJAn51PKtTUw2jd8MPkjMn8A8vywzLnkn7+a2PcyXI2PYa4hZoR+P0vfpBzl4TwU8 ZYFw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1759825958; x=1760430758; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=HprILVmlCINZEM+NQvrClrUcjHEMUlllXqO7BPuLx90=; b=tU6Hjo2psfd37/c3Y9Dj9GE4hxd6PUC7SrGh7mW4L+SyTciauaHEYtPB8oiVU+z6Y2 FMTlIy1XyVRmh1IY7cf/xGFsD5rDSovM+MCNqVS6RV1L4xRj3sizOFBMTTxyy87+Cvy+ PshwNbpuSVUkdiV/L4VrjQV6iL4N0CPkT1LImqcoV0/wyE7s01YUxUgxfC5P/SC+PP0N rqFIujl3trQft2SERJUYN00shq2/5C1X4ORYHg6n476rmSVz5xo4K5RR3LQBcqneNI63 eXEAnuir+9Z1WLFItv4tDQN/BOdlnu2qkna4yVzJyIAxsIGTI/G6vq7JJghPa0nOXh0o 8IuQ== X-Forwarded-Encrypted: i=1; AJvYcCXSTe0UlBF7rhE33czB8Tn1vR0BZzZgJucyYzUcw+/9Kz58WXk1VKfCMEYaD1guhKPzPPz1o7DFu1UEtjEq5y7U52w+GQ==@lists.linux.dev X-Gm-Message-State: AOJu0YwlrXB1c18aGK3Wbap65VC1PM4Nn/hR6uEHjRexXG9yIsP+Hytz GhVfaq9ELm5O5LJ4e+w8M8iiLzdldwspF2OZ5Qh8Os9U0QbuZ/J+3/aP X-Gm-Gg: ASbGncsrd2z94vq7mV8uKWuC7T72dwlnBUr9PktlnZJJ1WsaZ1MKsggjYTMpzd7QgL4 PkjcdRRzsPkPjh9zAF0tKiqaDjtnZlBDb7uF+nHi7Wos4Qlc7WgLVtfWE6b1PgovD/mMFR/g1CP GPZgTaZMm7KnYAYk9UZ2tgwbT5Bm/6D+UTWmIgegY/2eSpdgi404J5Caf108km9MbGSJawcrMak i6uGeB0so/e1/XfWaONBkhCxdIOu28wQrynuEVp/NazJytFBRDa3jewnNw4vVjfD6xHLQh6LL5b b77BRKDmdBB/+3wG4vl5ufJdctLJKF0VGMq1astsMDXo2s8AD+ox2zq2EyoxEzZs2v7N7AiL6oO nRbT/EtS2u5nSHw3As8PsDtZi+LAVxcDcI4KxSH81ofK7cbmsxQVqanAb+zTl9bTE/g== X-Google-Smtp-Source: AGHT+IEQinegNp0eryTjEE/PSB7WT+WxKJi2rEkoILL6p0tSCG8SZofKeGirNv90BH6Yz68RvHxRpw== X-Received: by 2002:a17:903:3c25:b0:28e:9427:68f6 with SMTP id d9443c01a7336-28e9a593d32mr183371865ad.27.1759825957801; Tue, 07 Oct 2025 01:32:37 -0700 (PDT) Received: from kforge.gk.pfsense.com ([103.70.166.143]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-28e8d1d24aesm157032525ad.118.2025.10.07.01.32.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Oct 2025 01:32:37 -0700 (PDT) From: Gopi Krishna Menon To: rostedt@goodmis.org, corbet@lwn.net Cc: Gopi Krishna Menon , linux-trace-kernel@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, skhan@linuxfoundation.org, david.hunter.linux@gmail.com, khalid@kernel.org, linux-kernel-mentees@lists.linux.dev Subject: [PATCH] Documentation/rtla: fix htmldocs build error by renaming common_options.rst Date: Tue, 7 Oct 2025 14:02:26 +0530 Message-ID: <20251007083228.17319-1-krishnagopi487@gmail.com> X-Mailer: git-send-email 2.43.0 Precedence: bulk X-Mailing-List: linux-kernel-mentees@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Running "make htmldocs" generates the following build errors for common_options.rst Documentation/tools/rtla/common_options.rst:58: ERROR: Undefined substitution referenced: "threshold". Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tool". Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "thresharg". Documentation/tools/rtla/common_options.rst:88: ERROR: Undefined substitution referenced: "tracer". Documentation/tools/rtla/common_options.rst:92: ERROR: Undefined substitution referenced: "tracer". Documentation/tools/rtla/common_options.rst:98: ERROR: Undefined substitution referenced: "actionsperf". Documentation/tools/rtla/common_options.rst:113: ERROR: Undefined substitution referenced: "tool". common_options.rst is intended to be included by other rtla documents and is not meant to be built as a standalone document. It contains substitutions that are only resolved by other documents, so building it independently results in 'undefined substitution referenced' errors. Rename common_options.rst to common_options.txt to prevent Sphinx from building it as a standalone document and update the include references accordingly. Signed-off-by: Gopi Krishna Menon --- Note: reStructuredText substitutions - https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions Tested by running "make htmldocs" before and after the change, verifying that no substitution errors are generated and the output renders correctly in browsers. .../tools/rtla/{common_options.rst => common_options.txt} | 0 Documentation/tools/rtla/rtla-hwnoise.rst | 2 +- Documentation/tools/rtla/rtla-osnoise-hist.rst | 2 +- Documentation/tools/rtla/rtla-osnoise-top.rst | 2 +- Documentation/tools/rtla/rtla-timerlat-hist.rst | 2 +- Documentation/tools/rtla/rtla-timerlat-top.rst | 2 +- 6 files changed, 5 insertions(+), 5 deletions(-) rename Documentation/tools/rtla/{common_options.rst => common_options.txt} (100%) diff --git a/Documentation/tools/rtla/common_options.rst b/Documentation/tools/rtla/common_options.txt similarity index 100% rename from Documentation/tools/rtla/common_options.rst rename to Documentation/tools/rtla/common_options.txt diff --git a/Documentation/tools/rtla/rtla-hwnoise.rst b/Documentation/tools/rtla/rtla-hwnoise.rst index 3a7163c02ac8..cc2721315552 100644 --- a/Documentation/tools/rtla/rtla-hwnoise.rst +++ b/Documentation/tools/rtla/rtla-hwnoise.rst @@ -33,7 +33,7 @@ OPTIONS .. include:: common_top_options.rst -.. include:: common_options.rst +.. include:: common_options.txt EXAMPLE ======= diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst index 1fc60ef26106..a11c485f127a 100644 --- a/Documentation/tools/rtla/rtla-osnoise-hist.rst +++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst @@ -28,7 +28,7 @@ OPTIONS .. include:: common_hist_options.rst -.. include:: common_options.rst +.. include:: common_options.txt EXAMPLE ======= diff --git a/Documentation/tools/rtla/rtla-osnoise-top.rst b/Documentation/tools/rtla/rtla-osnoise-top.rst index b1cbd7bcd4ae..c7bc716b2899 100644 --- a/Documentation/tools/rtla/rtla-osnoise-top.rst +++ b/Documentation/tools/rtla/rtla-osnoise-top.rst @@ -30,7 +30,7 @@ OPTIONS .. include:: common_top_options.rst -.. include:: common_options.rst +.. include:: common_options.txt EXAMPLE ======= diff --git a/Documentation/tools/rtla/rtla-timerlat-hist.rst b/Documentation/tools/rtla/rtla-timerlat-hist.rst index 4923a362129b..547dfc7ace58 100644 --- a/Documentation/tools/rtla/rtla-timerlat-hist.rst +++ b/Documentation/tools/rtla/rtla-timerlat-hist.rst @@ -29,7 +29,7 @@ OPTIONS .. include:: common_hist_options.rst -.. include:: common_options.rst +.. include:: common_options.txt .. include:: common_timerlat_aa.rst diff --git a/Documentation/tools/rtla/rtla-timerlat-top.rst b/Documentation/tools/rtla/rtla-timerlat-top.rst index 50968cdd2095..3740fd386ea8 100644 --- a/Documentation/tools/rtla/rtla-timerlat-top.rst +++ b/Documentation/tools/rtla/rtla-timerlat-top.rst @@ -30,7 +30,7 @@ OPTIONS .. include:: common_top_options.rst -.. include:: common_options.rst +.. include:: common_options.txt .. include:: common_timerlat_aa.rst -- 2.43.0