From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wm1-f46.google.com (mail-wm1-f46.google.com [209.85.128.46]) (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 DB0F0394490 for ; Wed, 17 Jun 2026 09:13:18 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.46 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1781687600; cv=none; b=myOHduG1ckiw8xB4ePx0QQVLpCFQAO2Fqpkm/8gf55lqcna7mQotOWiB6TWd5l+INYVR2FZAbVLVjVepRritU2BQ1VTdHJU+Uedyvn/KcZN2XssyHRkHS2KeOWajV8oo+ZspoeclC8fESucEbgrXUKYHf0XEViHKOJDQwmfwMCQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1781687600; c=relaxed/simple; bh=VNb8Oeo8fsnl2dNubUFSWKcRBi3wEZOagsaNZh7wB14=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=UZTcp6dctxPVS8jys/jl+5wwvnSaExQ+SqEQVxf4uNmZbiC82Lw5TjCZCrdH9wP5IZXrrwps0wAmtRRmh7SO/f9tkmpL5tKtFA81hecEXQf+WuCYLHqLCg+ADPNxbHw7hn6MqQjaI1WKu0GCacRNkhZz6J8v51FfvXt9Qr9b+tQ= 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=CXPlLkEF; arc=none smtp.client-ip=209.85.128.46 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="CXPlLkEF" Received: by mail-wm1-f46.google.com with SMTP id 5b1f17b1804b1-490b8ac62baso6845925e9.0 for ; Wed, 17 Jun 2026 02:13:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1781687597; x=1782292397; darn=vger.kernel.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=pdzEnJF2ilqo5mGBwtUC4XQR13hh+SJ7AGP/8bu8ACk=; b=CXPlLkEF+mjs8vpLhTWd+Sc6t6QohlDW0zR+1qcMjm4Su3Jd32HU2gmk3tPPTWwaNP p9ssRghKH/qE8kop/lDoIOGRnrReIUl1o2il41jH0H49gm4lnXzQzLptSBCUj5j9fKQv EU+PWayJVz916sv4cYsraFktqAZx98W+EwtlHyw24vzczbsTM+LAoMcoHaSVW++876zX P3iJ/62XtmEQ8fnKOLJvA6DPlQK+v2XT3snuEaU3mmisnQLKl5Q3dwRQBaDaX8slWqWS RsyYUdHifQo7y0YeDmzP4nB0vvmJlfur2CQGxUonbu7xpZLhA88JF1/R/TwQYSve1V/l ECxw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1781687597; x=1782292397; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-gg:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=pdzEnJF2ilqo5mGBwtUC4XQR13hh+SJ7AGP/8bu8ACk=; b=QQE1DIu24aHDP9FAVGDiktJvgcPlDqBUNnD++k/6c5RBhBoustjM4nT0/MG6zaLlFe CtJ71r35dq5nqL9kqJ0occbR1cjzT/pQdsjPetYBywGsNAJkoZiSN/UNggsr/PLqcqv3 rSi9gSVtHrCKS2beae9+ek2SHBU4Ck+gAWtoax5G/vrYFyo7MbCvXdWWP8Jq3hRFdRXi +bvecw9YIWAPYxgizikimCj69vyZhEAhZ0wVWwkwU7Qg/hAEJAmkTEmNH/NWVMnBwtK+ ih3VIsr/6/xpCIU3NZZYM7hFrn+9dCB9/6ymBxA/BmuMKCYyVUn4IyHFHfxVvBDrSo0V 5lCA== X-Forwarded-Encrypted: i=1; AFNElJ/x0wM4mG1IcHCpCWhbcggmqJNbypGEahZ2isPl8Kcnm4onQJmMAU/Dw9Vhtna50Uye/XzcKthGZ4Z6LfM=@vger.kernel.org X-Gm-Message-State: AOJu0Yyzx8utrfX64Mq5ZiptAQbawDivKUznIv0KCiLb6TVTGDCsxREQ pCw9SSFgtO0wo3wXqtZhnm7+3dJyY7Lq+3ECzNszUuJ8cbbbFaQYYt0v X-Gm-Gg: Acq92OE65egdxROAfAJkBjpqayo73QyLDYwe7YRIewyRHVJaZMjZqPqqtIKwrUU0cB8 t494iu1agT3+b5st3H+3kgxTSUG+y2B4L7zpzQjL5xFfpcU6AT6r1coPFfx8igYcBmiSS4dSno+ 796zHzcZuVrwPZfpqiWB5vwbLRqkatRTwKRHbzrwAI6pl0PY4S2CXMqCgM223W/m3Sl6mAAQ+qf pmmGWqZMzqgusS0pxees0OrDB8qYKaB0rRkd5Uzp4VKE9Wa4je6ZJ2hmzxZG9zhLpCr5JQqsC/N cScI72sWTkg9Te9IvAaNRAMWmeDIXZsAt5vlCCxgF9UQXzCRWthaWlfwJ3n+V49pnK28CJnAoCJ +9BUcIS84Xtkg1yoAAHoI/mh3j0H+rCWDfLajkr+d/VIZBCoV0dRaFqbLNc6WWmuXtp/JPvxjze hCxzi6TfmIrc33Xip0eWkoCM76vwbHQG76PTUz8stTShrv7G+mgvgN X-Received: by 2002:a05:600c:5290:b0:490:af63:2cb1 with SMTP id 5b1f17b1804b1-492340c604emr29094785e9.7.1781687596953; Wed, 17 Jun 2026 02:13:16 -0700 (PDT) Received: from [172.16.16.38] ([195.100.225.50]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-49230a0e9e4sm130471915e9.0.2026.06.17.02.13.15 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 17 Jun 2026 02:13:16 -0700 (PDT) Message-ID: <75552e2d-0bc8-40a0-b783-fba64482aea9@gmail.com> Date: Wed, 17 Jun 2026 11:13:14 +0200 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 v3] rust: add procedural macro for declaring configfs attributes To: Miguel Ojeda Cc: Andreas Hindborg , Breno Leitao , Miguel Ojeda , Boqun Feng , Gary Guo , =?UTF-8?Q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Alice Ryhl , Trevor Gross , Danilo Krummrich , Jens Axboe , Luis Chamberlain , Petr Pavlu , Daniel Gomez , Sami Tolvanen , Aaron Tomlin , linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-block@vger.kernel.org, linux-modules@vger.kernel.org References: <20260612-configfs-syn-v3-1-3292fbc5cc32@gmail.com> Content-Language: en-US, en-AU From: Malte Wechter In-Reply-To: Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit On 6/13/26 12:41 PM, Miguel Ojeda wrote: > Hi Malte, > > Some quick notes... > > On Fri, Jun 12, 2026 at 3:29 PM Malte Wechter wrote: >> +/// ```ignore > Empty /// before examples. > >> +/// // This will extract "foo: " into a variable named "foo". > ` instead of " > > i.e. please use Markdown > >> +///``` > Missing space indentation > >> +/// Expands the following output: >> +/// let item_type = { > Missing example block, both at the beginning and the end. > > Please double-check by generating the docs and looking at how they > appear in the browser. > > The prefix of the title should likely be `rust: configfs:`. > > Thanks! > > Cheers, > Miguel As of now doc strings are not generated for private items in the macros crate. I am moving the `parse_ordered_fields!` macro into macros/helpers.rs but this means the doc strings are not generated for the macro anymore. The `parse_ordered_fields!` macro is a larger helper function, and the doc strings are relevant and helpful for macro developers that wants to use it. You can enable documenting private items: diff --git a/rust/Makefile b/rust/Makefile index b361bfedfdf0..b4239443307e 100644 --- a/rust/Makefile +++ b/rust/Makefile @@ -147,6 +147,7 @@ quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $<      OBJTREE=$(abspath $(objtree)) \      $(RUSTDOC) $(filter-out $(skip_flags) --remap-path-scope=%,$(if $(rustdoc_host),$(rust_common_flags),$(rust_flags))) \          $(rustc_target_flags) -L$(objtree)/$(obj) \ +        --document-private-items \          -Zunstable-options --generate-link-to-definition \          --output $(rustdoc_output) \          --crate-name $(subst rustdoc-,,$@) \ But this enables _all_ private items to get rendered, which is not ideal. How should i proceed? Best regards, Malte