Received: by 2002:a25:1985:0:0:0:0:0 with SMTP id 127csp247575ybz;
        Wed, 15 Apr 2020 08:03:22 -0700 (PDT)
X-Google-Smtp-Source: APiQypLbD9a/1pEpfFsG4Cgkfwe2rMR6k/tdseVEiH8W1F2MqbXduzSAFK4kHmEZli/ggTcBTIm7
X-Received: by 2002:adf:a3d5:: with SMTP id m21mr30152154wrb.54.1586963001952;
        Wed, 15 Apr 2020 08:03:21 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; t=1586963001; cv=none;
        d=google.com; s=arc-20160816;
        b=Km+baqHpq9MWgk1ZCLCVh5mpXx+Q+/bUVPb5Bf7dQb+4+vceO9gUdLab/wEyp0Xxu6
         X523++m/2PpRNB7kh2aWScBzRCdZ72GKTsDt75xv/vreJ1d+2pbo5xjDmSFwCYR4H3g5
         Toj15g6nr1utkfx9j+asTeTBLplKmoEmlChWGOsRrJRZpjXqoKBJdxX+FIQ2Ef02eWvx
         h1d1r7UqIcTpHicK0U6B7A9q+o5/wKF/h7pm+IQcmQZCnylM32QDBU4MErGuCw0feGqr
         yXA0mubqjFUf1MkuiBS7aI4rI59Cmzzo73phvbJKCvd6wigymSYSpNN+UZyNMpXd5/F9
         nalA==
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
         :mime-version:dkim-signature;
        bh=4k8kfX6jIEgDhdAPsrHcln1Ddwi4D7YyK+0yUrDlqSg=;
        b=yjMP0p203vyYu54am0ZTvtKbK0xi8kjko8FF2eMamp1cao+DtrcJ9Qgh+uW6ys3VRx
         hvcNYrCa3O/ygh2xLVI4kAYpsWMqHrFxXWddYuTKjuPZzBJeMi3Oa3xk1xyyZeqkikV/
         9krf37oVT+55N3KhH10yD2daHkUSk2KcuuqRObR8jXshZGkljlU6WHI95GFGGrzYm6a1
         iZ8JpR+SlhnOwx0kqUtiavb8chH1RnOrnp3oawluNEZLMmskebkiNDTmsZw2mQfn1OUk
         PPDwFWiaRRQFiy7jzL4AVT6w86X6KiuaTgfExd1xezyEAuf7IcHn5RSP4oU2t0MhPgE3
         9WNA==
ARC-Authentication-Results: i=1; mx.google.com;
       dkim=pass header.i=@gmail.com header.s=20161025 header.b=RAfqyGIO;
       spf=pass (google.com: best guess record for 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: <linux-kernel-owner@vger.kernel.org>
Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18])
        by mx.google.com with ESMTP id v11si3372667edy.483.2020.04.15.08.02.13;
        Wed, 15 Apr 2020 08:03:21 -0700 (PDT)
Received-SPF: pass (google.com: best guess record for 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=RAfqyGIO;
       spf=pass (google.com: best guess record for 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 S2391500AbgDODzQ (ORCPT <rfc822;uzarths@gmail.com> + 99 others);
        Tue, 14 Apr 2020 23:55:16 -0400
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53254 "EHLO
        lindbergh.monkeyblade.net" rhost-flags-OK-FAIL-OK-FAIL)
        by vger.kernel.org with ESMTP id S1733225AbgDODzO (ORCPT
        <rfc822;linux-kernel@vger.kernel.org>);
        Tue, 14 Apr 2020 23:55:14 -0400
Received: from mail-qt1-x82f.google.com (mail-qt1-x82f.google.com [IPv6:2607:f8b0:4864:20::82f])
        by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9B019C061A0C;
        Tue, 14 Apr 2020 20:55:14 -0700 (PDT)
Received: by mail-qt1-x82f.google.com with SMTP id x2so12221126qtr.0;
        Tue, 14 Apr 2020 20:55:14 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=gmail.com; s=20161025;
        h=mime-version:from:date:message-id:subject:to:cc;
        bh=4k8kfX6jIEgDhdAPsrHcln1Ddwi4D7YyK+0yUrDlqSg=;
        b=RAfqyGIOObyvOPi3F4NT32FtHzHYlWzY/aqw7ooP/b65kZSkZU8Db+XlmbpQ1+wixo
         znKhltePa+CqaSMni4OgcdV1iESyIoA4OoRmZf8ZJdKkQmcNcbb1/kXukLBKxRU4snuz
         ZiAKh+Poyyf6Q1LsaC4a78ZaOC0+Tb7+q6OFqOVTBPo9yqZMz+6HBcbJI1QpE4ukR1wd
         UwUlI3AxMx6cNTnDP9WNT96npeqF+MpGxaAqF4Trvg42Y4KtmP0vn2lICuQNF9ZdRmVB
         R6bim1DomCYqoibTgJEhU736pMc1PqEtUwNpJons1XfsjzolG0VQwkuHj5KHem532+KG
         wiUg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=1e100.net; s=20161025;
        h=x-gm-message-state:mime-version:from:date:message-id:subject:to:cc;
        bh=4k8kfX6jIEgDhdAPsrHcln1Ddwi4D7YyK+0yUrDlqSg=;
        b=LWKnuocMnnVxHrlIZ/WTSIZCAIc/szjfQwN6T1eCCPQfDQGDRt1CMHHeji6TI/KE0P
         zWo50yueIYQDZPyQLcGLR/aw/b+Kg2jxvg3kqAiNGySlb2W6ZZiso9SrS3mPTu/9gkDY
         lu1cWuZY6jrBbUV4JtKgCRZhOwgXFcqdUoP4gWmioiH/v5vC1raeydCpo4cBS5Gtv2CA
         QlawObwF3SJCbqJv6x96BW/s2RBsrLOvHKGRActgHi1KzJzk7DGIgT602NUcC4xc2aIi
         fscTmjFEe2KkZbspu71dx34Pip3NbaJ2Yr4nIoAQV2bqMmbhD1TtnZp6DOpH9cbmKuCE
         GSaQ==
X-Gm-Message-State: AGi0PubW/W9qyqLrqYojQzIpWOlohjAZBBUPrD6YaciggSChRI54ZDhX
        YsprcyLutDdCaROuFbWODhpyf+k6sszYRA+L1EHS5jPV
X-Received: by 2002:ac8:4e45:: with SMTP id e5mr19662711qtw.101.1586922913095;
 Tue, 14 Apr 2020 20:55:13 -0700 (PDT)
MIME-Version: 1.0
From:   rishi gupta <gupt21@gmail.com>
Date:   Wed, 15 Apr 2020 09:25:02 +0530
Message-ID: <CALUj-gsRgkEyRe3vubEeWx8ENwEyE+Fzv4bKKDZ+iq3urRG0BA@mail.gmail.com>
Subject: Correct place to put the new doc for "How to use this driver"
To:     linux-doc@vger.kernel.org, corbet@lwn.net
Cc:     lkml <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

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?

(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

Regards,
Rishi