Received: by 2002:a05:7412:8d1c:b0:fa:4c10:6cad with SMTP id bj28csp127916rdb; Tue, 16 Jan 2024 18:02:36 -0800 (PST) X-Google-Smtp-Source: AGHT+IE1fACeMvC0KI7DbXroeSV6YPFOwASjqhNV+kBK1FpCP4ur8vRmOB3CGGmv9hjlGYmrbTBd X-Received: by 2002:a05:6830:910:b0:6dd:dda6:67b3 with SMTP id v16-20020a056830091000b006dddda667b3mr8812841ott.67.1705456955902; Tue, 16 Jan 2024 18:02:35 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1705456955; cv=pass; d=google.com; s=arc-20160816; b=Us7UqY7PZRskybht7aHOLG/OmpRPNclmQc1v+WISUm5bSB6wlyyZQLbQXj7U3HKH5c 3G2zqOsQ8VbMcwNxeqJljQpKc/unrL4COxGNj/ywhr/6ok+kNLDwoJNwbBWReJlZhVHa efVqzDHoA0xxk4iJm0ItN09BLKSPEg1Hh3BVIKmsOvr07ereecDqt0bjfD71jTij+ct0 XirO1U2jqZqPjJlbem+VptQjy9QBChuIekxENXs6gfeTkFI43Xy8CP4IJ6Vd77Zw6AYl Uk43xoo4yc41r+awJ9uwwqqcvGa0iNtJvhP1APH7BxKmgCeqltea5tFD2wlN7/2HAtXq hfpw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:in-reply-to:from:references:cc:to :content-language:subject:user-agent:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:date:message-id:dkim-signature; bh=cRKV7zkrl5aMjYceZld1VkQyBEeoC8GABh+p6k8LCpc=; fh=7HwBROJ+LUnE19MCFEhBsd56CJsPamyyBgED4XQt+hU=; b=PawIdvWNlp9GI6sj1R5l7SK8gAtvlCsIQl/7lX+umyI4XB3je3KL9RcBpjaDQy9x+J 1BPxPSlkJATyJCwhvUvbOZT1pXgFQ73AfbjTeXavvXKpVJempFJaeFDsrsZdVXpbtcMZ XZyPnuXY870RZOdFU3YRLb8wIVm/crfG0KkmTErOwd+AadEpBl6n7jrPFgzOix0CSAKz wRXuNExVQYMPEWS/bktyejM459GIu3jaUi0910ujKV3ZAG1rl9JipTjJF36IfHhSuuWz 9BWwH31ftbg2YKIb6amwTkt3ZldscOTVWZZr+RgJy2rIR5kxVS8x7kQxNl+sjbzLElzx VwXg== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=DdaRLlq7; arc=pass (i=1 spf=pass spfdomain=gmail.com dkim=pass dkdomain=gmail.com dmarc=pass fromdomain=gmail.com); spf=pass (google.com: domain of linux-kernel+bounces-28451-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-28451-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from sv.mirrors.kernel.org (sv.mirrors.kernel.org. [2604:1380:45e3:2400::1]) by mx.google.com with ESMTPS id y37-20020a056a001ca500b006d9ab8c2a93si601641pfw.56.2024.01.16.18.02.35 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jan 2024 18:02:35 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-28451-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20230601 header.b=DdaRLlq7; arc=pass (i=1 spf=pass spfdomain=gmail.com dkim=pass dkdomain=gmail.com dmarc=pass fromdomain=gmail.com); spf=pass (google.com: domain of linux-kernel+bounces-28451-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-28451-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sv.mirrors.kernel.org (Postfix) with ESMTPS id A5862283A37 for ; Wed, 17 Jan 2024 02:00:37 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id EC116BA29; Wed, 17 Jan 2024 01:59:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="DdaRLlq7" Received: from mail-oi1-f174.google.com (mail-oi1-f174.google.com [209.85.167.174]) (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 CB412B658; Wed, 17 Jan 2024 01:59:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.167.174 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705456762; cv=none; b=F9nuR1qxYp0BzrbXyKPSbfvYFB6b7YYhy9wPC+yOMkWAynMxrUK1MBlww7SQaVkD0D2a0VaqeisOMrTJURWhD5HI2qaBAPuEugyje2YayA7bGaNkFSlAO5RsE+8I5r/PxuUximlfA5cFh1jGg2U+wwgMccQltK4cEWX0T5T+F0Y= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1705456762; c=relaxed/simple; bh=Q7ZAXq45jDLN9Qa5cpxzsBvnQmAbmuhAz4R/pS1S7Tc=; h=Received:DKIM-Signature:X-Google-DKIM-Signature: X-Gm-Message-State:X-Google-Smtp-Source:X-Received:Received: Message-ID:Date:MIME-Version:User-Agent:Subject:Content-Language: To:Cc:References:From:In-Reply-To:Content-Type: Content-Transfer-Encoding; b=Hk3k7ZREvjhb/EEggJcMlR160ryf0HY6+Aqu6gDQbEyXACrDeS8kJrAiQp6fTPBxd3foaBv5mL8PKt69fOMfiUyDMNyV5quPMdaVXdtULdLG5l+SJKZw2DIZEsZT2sZ+Fk3bGXaU0DM63RtIv4RTT4n7WqUJmLe3RG4eBqeOONM= 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=DdaRLlq7; arc=none smtp.client-ip=209.85.167.174 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 Received: by mail-oi1-f174.google.com with SMTP id 5614622812f47-3bd6581bca0so2358572b6e.0; Tue, 16 Jan 2024 17:59:20 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1705456760; x=1706061560; darn=vger.kernel.org; h=content-transfer-encoding:in-reply-to:from:references:cc:to :content-language:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=cRKV7zkrl5aMjYceZld1VkQyBEeoC8GABh+p6k8LCpc=; b=DdaRLlq7TG7yG+euPIxlWh39Ju+MnI8BwcFGSLgWGkW/teMckJT09p6a1kCtGr0CXs xthMrJv5+Imddhwu6vjEpxihwPMhCFvI8iWsrUhqcYR4gQmgvISnD0UNDA5A4f1nh3AK ypxiUnR70Jwp4pFkXpmrjSmvh0e1kUhI6uZ//d2ZWogvrzSai0XGdT8mcOSEx8lBAcTI zuQew772OP2N6M0gIDZK6RAwsVwM5jvSEd4TLwojPbWLadPPkRvrS6CFuB7KaN3Q3ocv a8P36t+Tw5plUD0WHazCbyKoZyDODIxIW1TZL1aC9Lm7os7Kb/kTPCaWCCdaKjSIhGTZ UVbQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1705456760; x=1706061560; h=content-transfer-encoding:in-reply-to:from:references:cc:to :content-language:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=cRKV7zkrl5aMjYceZld1VkQyBEeoC8GABh+p6k8LCpc=; b=F8fni12oKDFOWFOe+MoJGSax6Lu2XMew6X66fEz2i06KejnWrMS1CTUzVm0AnNXZpW x/Yq+cFmlB9fJJeKhY/hBeptVinK+/1Eu/7SEOgk7jvmeFFLz/RgPIFTCQaU3jnkQXJP W8+aeuFJL8JxjIn8uVg1ekjTf7KEihtgi9/J+Y46fWARQzwR4oFZfl1Yq6EdCBztk3VQ 5Am5WmhJj5MvqXsUiB4ACdb5Jt28+H4ehA4dyiFVDLbszPcZmpczLjFacivG9cfMaFZh zB5zZn3zWp4Ny6D5lSa5SirL8X6ukoCfv3iarUOgNBCZ07XJ4Ad3qiFX3I/Qn2rtB0z+ p/lA== X-Gm-Message-State: AOJu0YyUYNPUUcmiFGeGM+qo43BKh0IQrhy7QMhAguXvF6Y22ECOqqrM 92pTvcAECVkWkepGqTYRQ14= X-Received: by 2002:a05:6808:2e9b:b0:3bd:7227:745 with SMTP id gt27-20020a0568082e9b00b003bd72270745mr7576546oib.82.1705456759832; Tue, 16 Jan 2024 17:59:19 -0800 (PST) Received: from [192.168.54.105] (static.220.238.itcsa.net. [190.15.220.238]) by smtp.gmail.com with ESMTPSA id e13-20020aa798cd000000b006da105deedesm237836pfm.197.2024.01.16.17.59.16 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 16 Jan 2024 17:59:19 -0800 (PST) Message-ID: Date: Tue, 16 Jan 2024 22:47:24 -0300 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH 11/13] rust: kernel: add doclinks with html tags Content-Language: en-US To: Valentin Obst , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho Cc: Boqun Feng , Gary Guo , =?UTF-8?Q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org References: <20240116160141.165951-1-kernel@valentinobst.de> <20240116231118.168882-1-kernel@valentinobst.de> From: Martin Rodriguez Reboredo In-Reply-To: <20240116231118.168882-1-kernel@valentinobst.de> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit On 1/16/24 20:11, Valentin Obst wrote: > Add doclinks to existing documentation. Use html 'code' tags to add > links to items that cannot be linked with the normal syntax. > > The use of html tags is a tradeoff between the readability of the > documentation's source code and the ergonomics of the generated content. > > Signed-off-by: Valentin Obst > --- > [...] > @@ -14,7 +14,8 @@ > > /// Byte string without UTF-8 validity guarantee. > /// > -/// `BStr` is simply an alias to `[u8]`, but has a more evident semantical meaning. > +/// `BStr` is simply an alias to [[u8]], but has a more evident > +/// semantical meaning. Isn't there a way to escape square brackets with backslashes with mbBook? Like `\[qux\]` or something? I ask this because this affects the readability of the doc comment so if that could be omitted it'll be really good. > pub type BStr = [u8]; > > /// Creates a new [`BStr`] from a string literal. > [...]