Received: by 2002:a25:1985:0:0:0:0:0 with SMTP id 127csp709746ybz; Wed, 15 Apr 2020 17:13:45 -0700 (PDT) X-Google-Smtp-Source: APiQypLapzpmYF1su97DBqmx+f2BWypXxUhokvDfVVJifeRsNEBQie1HuFFzld5wLLb/9QVkM5PT X-Received: by 2002:aa7:cc8a:: with SMTP id p10mr28721570edt.185.1586996025796; Wed, 15 Apr 2020 17:13:45 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1586996025; cv=none; d=google.com; s=arc-20160816; b=cd5ByA4LaiHjHpQSFRg6JMRQS0qsp6BIpOx0dD3qh9Xe1fpnONLKdCDcuaJZjzyO0d a/Yx2t9c9jePu/5TUNJMR3mJ+LKrXJv7Qtp0b8eMnV3kW/k1AJ+l8tWba+D4fs2qNFXW 6mNWJqpUJBNXl1SOqoX2ASoxLCnDpY02I3t4x1NwxK9Hrre3ZeBMKYroe7dbWOi9W7Wf r9L+5xRSWOmbRlw/No+Rka5EKc7QEhYkFXaf22q/OJMnY1m7w2pGSXkWeVk3S+ptW7JA oOetACtDbrB6Z46YQ+qrupAKTiYl5APTzHFdbwCJ6U9viASMKqRzuIpuiHgRyijeB9GO fedQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:dkim-signature; bh=EZ4iMxtLmyt1fidTbl+NFGEvP3aHTCvbYm4rWcaVlyA=; b=zEaFcXl3NmhFokh1uWkDW0uhQgTJenIv5KvmHTgV6/j3omLI14WnDNtH87L1IQ/dNq PYylknYYDCZL4e5ClbyPxpqaXLqlmk7jO0L3UpGChhcDdin5ONCs0qVJqwJEOxugbuYW Hy/6rG0DXBkf9qRTib4evnyKydnr0jXrdap3aJzU/pyIx+Lc7nc6kerSa/+nz9fv2lRl O+j+FUbvGcD13pq0LquIe+BdZLNHKRhV2Fcpm19KdstMJT/R5eL2jP/JgwzqjLeYaIBQ GjcMl5q4jCE7YK2lz48/J9NmV4ZuQzcLf5L+dJ7tnT6xli8sgZcoKU4VpISRwYuUseMi MH1Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=Yt4KqbBY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id i3si10853124ejx.334.2020.04.15.17.13.22; Wed, 15 Apr 2020 17:13:45 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=Yt4KqbBY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2636851AbgDOOry (ORCPT + 99 others); Wed, 15 Apr 2020 10:47:54 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41670 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S2392410AbgDOOrs (ORCPT ); Wed, 15 Apr 2020 10:47:48 -0400 Received: from mail-qk1-x72a.google.com (mail-qk1-x72a.google.com [IPv6:2607:f8b0:4864:20::72a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E5BD6C061A0C; Wed, 15 Apr 2020 07:47:47 -0700 (PDT) Received: by mail-qk1-x72a.google.com with SMTP id b62so17453548qkf.6; Wed, 15 Apr 2020 07:47:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=EZ4iMxtLmyt1fidTbl+NFGEvP3aHTCvbYm4rWcaVlyA=; b=Yt4KqbBYzrcQoQQlbdCqsuee3b+HaiUsutQD8Qbx5syhE1/i1Cw+VMzbLyCKcYaRYi WAa0/Tvi6yhSrD3vkuaptsmzvS5iqXwB8vfcW40nQ8iC7S6SHHv6vSE/1fblaHpM7xPd INyYDeTWPradXrWH0Te8CMeemJUNXr1N6tnq7e7HIaeDgeTLK0uYENrtc6B181jOAytd kENWGTYOc074TwDs0ADlLkl7NssWed71MbxwMz5AIQpugB4nBUdrlFmViwh/4LDbffo7 j2sYfHlFC4fGGkxGRMrmkcXPAUWvDANSAxFpooShlv547O6GeNpnSRrpzBY7T1nDdaiP qQew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=EZ4iMxtLmyt1fidTbl+NFGEvP3aHTCvbYm4rWcaVlyA=; b=QR+kqWnUg6Iu1UgZNwSXDYrSvleYfh5Q9tpoY3SPRijHw+5ISY31N9lGNnsb6Es5p7 wTnrx59a6k9bi6074raDnHPopx3NYoutDzG4RNrKGnVD3An4kA/MyJDtHndMQyBsQU/I imyiKX8RudygS2bkcYcS1WtKx3652GxWdaGhtImkWzWwLO3XduXwJ8kkmjSOuk01vzYG hHYC/K7ylLUImK6AQW9UYkt5szTfKiW+h9Li7XtM5zVrYoVn4NO/fpkADuUv/O3FlZhK r1TUL9SY1gUmxWu7xZPo575L4jia3no9TLdWuFXXn91uIda0fL9mIFRiNsetp0rwXOdl iKpw== X-Gm-Message-State: AGi0PuYMyJqRu0xkA7vGQ9G+w8sxByzaj3nsSK6p7aI7z0TjuGfc7SsC OvQcrUBAIrsYeQ0ptNzJ02z5qM9P2OoCdR1FY5WUfUdX X-Received: by 2002:a37:a7cd:: with SMTP id q196mr2235781qke.160.1586962066994; Wed, 15 Apr 2020 07:47:46 -0700 (PDT) MIME-Version: 1.0 References: <20200415163851.2e5f96f8@coco.lan> In-Reply-To: <20200415163851.2e5f96f8@coco.lan> From: rishi gupta Date: Wed, 15 Apr 2020 20:17:35 +0530 Message-ID: Subject: Re: Correct place to put the new doc for "How to use this driver" To: Mauro Carvalho Chehab Cc: linux-doc@vger.kernel.org, corbet@lwn.net, lkml Content-Type: text/plain; charset="UTF-8" Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Thanks Mauro. I will put doc in admin-guide folder. On Wed, Apr 15, 2020 at 8:08 PM Mauro Carvalho Chehab wrote: > > Em Wed, 15 Apr 2020 09:25:02 +0530 > rishi gupta escreveu: > > > Hi Team, > > > > I need to add a documentation file to let users know "how to use this driver". > > Specifically this one (tty-ttyvs.rst): https://lkml.org/lkml/2020/2/15/153 > > > > (1) I am unable to find any directory where it will fit. This driver > > belongs to Virtual TTY device category. > > Any suggestions where to put it? > > Docs focused on driver usage belongs to the admin-guide. > > > > > (2) After putting it is it mandatory to link it to > > Documentation/index.rst as suggested here > > https://www.kernel.org/doc/html/latest/doc-guide/index.html > > You should actually add it to Documentation/admin-guide/index.rst. > > > > > Regards, > > Rishi > > > > Thanks, > Mauro