Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <49925549-f8ee-163e-9115-6cfd3de73e83@amd.com>
Date:   Mon, 17 Jul 2023 11:29:27 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.13.0
Subject: Re: [PATCH v7 0/2] docs: Integrate rustdoc into Rust documentation
Content-Language: en-US
To:     corbet@lwn.net, ojeda@kernel.org
Cc:     jani.nikula@linux.intel.com, rdunlap@infradead.org,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
        konstantin@linuxfoundation.org
References: <20230717151624.3470714-1-carlos.bilbao@amd.com>
From:   Carlos Bilbao <carlos.bilbao@amd.com>
In-Reply-To: <20230717151624.3470714-1-carlos.bilbao@amd.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?OFZCb2JqQ2x6RTFFNHhYNGdRWVozOXg4VkhzeE83WGdrck9VT2ROL1hITnhI?=
 =?utf-8?B?eHhLNEdiVGUzWjJpVGdrSWczQ0Y4elhUdysvdnY1Y2RtQm0xNTZwTVhCcENB?=
 =?utf-8?B?TjFFT2hrcDBWcnJlZ25sRTRSVGNOVEtxdXNMTi9zeEhJdjJSSWN2VGFzYWlq?=
 =?utf-8?B?ejhXVmhUdmw0cXdIcTFjK1RObjNMU3VUc0R6WnVZWHNLcUlTMkpxTzMyUUV0?=
 =?utf-8?B?MXpGYVI5QmJQL0xXR3FjazZxVyt3bm9oQUZ0NGZEOW9wZGlFc0RCMC9NWFZV?=
 =?utf-8?B?QTNTSFpDdGxTQzR2WVhnL1IzdVdKb29MQjIxayswV2U2N0FxSnFpeHVhbUpn?=
 =?utf-8?B?R25pU0NqZnBSa09YQ1JGZmp1MThrWERadXFMa2VOTHNkUzQ0VkkweTZoOE1v?=
 =?utf-8?B?cmc5MXd4clRYckQ1SyttQVpwQ1BIVFpBZ0dJYnpIeFhmbDJ3TnNRNkVQSTRV?=
 =?utf-8?B?ZE1mMjRobTVsQ0JLZWhON0Z1d1Axa1NGOXZIakl6NWtMZFBTNTRvb2tZbm94?=
 =?utf-8?B?UnFBM24yRUw3Z3Yxb1ZDVUZpOU9aOHhkSDRKdThXVEM2TFUrMlg3VDM1RWdu?=
 =?utf-8?B?aFZaVkd0ZlloUVhhd05aYTU3cnpWcllKd2pvUm1leVBoQ1VSaUgrMFVCWHEr?=
 =?utf-8?B?bit4bHZKc0cwWGY0bmg4a0d5eWFmWlRhRkdHcVFiUkRFM21yNmhDcmRnQXZL?=
 =?utf-8?B?MmkzZXpxNGErS2NpMjRhRlU5MTIzNnA1dGZwa1NsdVdNeitxWmc1eWxmUnVL?=
 =?utf-8?B?azFNazRKZkh3MXprdUxMYnlNZVV0aVdRS3ZIaU9kRFBGVWZjRklhaS9WbmVG?=
 =?utf-8?B?ZFprckRmMm9JZXplcW1QVTVrV0hXZ0Z5Sy9xSFpwZDUwMXdpRHZySHJGZnlw?=
 =?utf-8?B?akdFbk4ydWdLU0lVMThBM2JXVi9kVHU0YzVQR3N1eGNXUEFRa1lNblBTYzJx?=
 =?utf-8?B?K1h5NmpCQVZmVmpYOWFCV0FKMTNqdjF6YVBsNDVaa1duYU1XK09jdmM4S2lL?=
 =?utf-8?B?cjdSSTdFK0tXb29ENHJCeld2QXIzNVpYcllMYTlRVnR6RmlLZVFCLzVXS2Fm?=
 =?utf-8?B?OWQwaitNVVpOWWliQVRaRndTVkFlb2djQloyWkozYlZ6T3YzaHBvOTBFc2Rk?=
 =?utf-8?B?di93WVZVTUZ0aHBVUmpneFdvV0pCeUhJRWVzQVdsL3RaeG4rZVc0OEZDTmpt?=
 =?utf-8?B?ZkJKRHNxV2NqWTBxTWlRQTE4bmp6QjZxeWc0NkVBNHd4eWFTYW1PWDB1eFd3?=
 =?utf-8?B?Snk3SlkrV2ptd1c0aUZad2p5dnlmSHozYVhzU2Z2eFlNd01ObVVNWUJyNkpt?=
 =?utf-8?B?SzQ0M3ZLd3dmMDloWCsxV05ZWFNPSGY1STRTVytPZmo1dFM3RGVRL0VXaXll?=
 =?utf-8?B?aEx4ZFZXUFQrdEM5c1ZOSTZ4T0kvaG5uZUF5Ty9iRnlxVjVTeFBaK3dOdmVO?=
 =?utf-8?B?UjNkaDFnbFdKOTh5bTJOamdObEp0SEFmcitEUWJsNDhOWEdjV1EzMmFaY2g5?=
 =?utf-8?B?bi9FWk1ndlZ3c3l1TmhZWlpRQXUzVFpMeW9JRUhMaXZKQldWcGRwdVV6MWZM?=
 =?utf-8?B?OGFrLzNRaUppNGZiMzlXVFNzMGVSeEVlTVp4ZjRnb1VselBDU3lxc3B5ZG82?=
 =?utf-8?B?aWJwT1BVZ2xJUkR3b2pxVlVqbGVJU05xcEZHdExtenJSYzNTRytCZmpKWEhq?=
 =?utf-8?B?VzRFZ3ZJQ0F2QTJRUi9HN2xWMmVIc01MK0xIcnkyQUZSbnk3QzhXcGl1d3lE?=
 =?utf-8?B?MWlGM3g1U1haQUlURjlORzdlTS90SkgwQ2t1ZWtBMzJXaFFYMnh3czg0THBN?=
 =?utf-8?B?SStqKzJwMUl4OVIwY0NTbmZFSU8yNWo1bUVuSVRFSFNWL1NhTmp2MzFpSklU?=
 =?utf-8?B?SE5La1M4NTA0OXdXQ0xZaGQ2MjNBekZTRHhDYklRQXpKOWtNQ1M3elBIM2Y5?=
 =?utf-8?B?SXVOTmtFQWp4VlMrSzl3VVBOV3JId3d4Um1BNGNRaWliN1B2SFYzUnFDWWFt?=
 =?utf-8?B?cm9uNzBRZUZ1LzA5SzNSYndKSmF2RjdVUzFqWUk4M3orYzEzRGJnK01XdkxB?=
 =?utf-8?B?VjlBNFc5QmI3VnRuV21ieWJyNndpanhLeUF4TlhEVS9FRG9PV1o2ZWZzb0N3?=
 =?utf-8?Q?umBA8Kdl4/8eEGBHfOh0tp89I?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: f4e5d7fc-49f4-4783-ba92-08db86e2fe63
X-MS-Exchange-CrossTenant-AuthSource: BL1PR12MB5874.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Jul 2023 16:29:29.3996
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: oEZZRYMUNcZVu9aRVHOqETzUDdHUaPWXz5CRl0cDwDdA4vM2BCu4LeSi+QAdLZJA+xzROGNzDidDFGrq1kvVRA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ0PR12MB5501
X-Spam-Status: No, score=-1.2 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,NICE_REPLY_A,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_NONE,
        T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 7/17/23 10:16, Carlos Bilbao wrote:
> Include HTML output generated with rustdoc into the Linux kernel
> documentation on Rust.

Please, note that you can directly test the case in which .config is
not present by running `make htmldocs`. However, to test the case in which
CONFIG_RUST !=y, it is not enough to include a .config; you need to let the
kernel compile for a few seconds first. In other words, until the
compilation process is initiated (using `make`), the build system does not
parse the configuration file or use the defined options.

> 
> Carlos Bilbao:
>   docs: Move rustdoc output, cross-reference it
>   docs: Integrate rustdoc generation into htmldocs
> 
> ---
> V6 is https://lore.kernel.org/lkml/20230127165728.119507-1-carlos.bilbao@amd.com/
> Changes since V6:
>   - Skip Rust document generation entirely if .config doesn't exist.
> 
> Changes since V5:
>   - Continue executing htmldocs even if rustdoc fails.
> 
> Changes since V4:
>   - Limit rustdoc note only to html outputs.
> 
> Changes since V3:
>   - Added Reviewed-Bys from Akira Yokosawa.
>   - PATCH 1/2: Avoid error 404 adding tag `rustdoc` for Sphinx.
>   - PATCH 1/2: Don't use "here" as link text, describe destination instead.
>   - PATCH 2/2: Check CONFIG_RUST in a way that allows us to skip generation.
>   - PATCH 2/2: Reoder Sphinx runs so they complete even if rustdoc fails.
> 
> Changes since V2:
>   - Split v2 into two-patch series.
>   - Add "only:: html" directive in Documentation/rust/index.rst reference
> 
> Changes since V1:
>   - Work on top of v6.1-rc1.
>   - Don't use rustdoc.rst, instead add link to Documentation/rust/index.rst.
>   - In Documentation/Makefile, replace @make rustdoc for $(Q)$(MAKE) rustdoc.
>   - Don't do LLVM=1 for all rustdoc generation within `make htmldocs`.
>   - Add spaces on definition of RUSTDOC_OUTPUT, for consistency.
> 
> ---
>   Documentation/Makefile       | 20 ++++++++++++++++++++
>   Documentation/rust/index.rst |  8 ++++++++
>   rust/Makefile                | 15 +++++++++------
>   3 files changed, 37 insertions(+), 6 deletions(-)
> 

Thanks,
Carlos