From patchwork Mon Mar 29 22:18:29 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Xu X-Patchwork-Id: 12171049 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EF855C433DB for ; Mon, 29 Mar 2021 22:18:41 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 736846196E for ; Mon, 29 Mar 2021 22:18:41 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 736846196E Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id DE5E26B007D; Mon, 29 Mar 2021 18:18:40 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id D95C86B007E; Mon, 29 Mar 2021 18:18:40 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id C0F2D6B0080; Mon, 29 Mar 2021 18:18:40 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0211.hostedemail.com [216.40.44.211]) by kanga.kvack.org (Postfix) with ESMTP id A10816B007D for ; Mon, 29 Mar 2021 18:18:40 -0400 (EDT) Received: from smtpin16.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id 68BB8180AD822 for ; Mon, 29 Mar 2021 22:18:40 +0000 (UTC) X-FDA: 77974327200.16.CCA2B67 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by imf27.hostedemail.com (Postfix) with ESMTP id 0E00C80192E7 for ; Mon, 29 Mar 2021 22:18:33 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1617056319; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=AxxOMKO0JbpC+EfdhzQeTf1ZUeNGnbzaHAKBqeS221c=; b=HiGL4/BKgQhUE3dwIEfWHQRF0fq45Kc/zWj/YdRih/QTaQd66/QCNUMcp+Mqo6zoXUMyIP R1N+BqL8rWYxwJ6kYmFpZ54UfzGy1osG1HSAOoDQiMNqx0CqSVN09i6S9unDbT0NivhO2r 4wOyvGzmqhaowJd3T5+pS9Pq+pi4dOc= Received: from mail-qt1-f198.google.com (mail-qt1-f198.google.com [209.85.160.198]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-293-IljWjKh9M-SqhyGfpFqxYg-1; Mon, 29 Mar 2021 18:18:37 -0400 X-MC-Unique: IljWjKh9M-SqhyGfpFqxYg-1 Received: by mail-qt1-f198.google.com with SMTP id w2so8518526qts.18 for ; Mon, 29 Mar 2021 15:18:37 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=a2LCEVo4TBpl00I4ylw0j9DYE4xxtQovFWZPzhkRNFo=; b=O8B9C5u+H9qWwbO64emCGXmvoCJ3MFRnC0j2zbSXQZnMUT2bonvAuNbA+CHlU+KFlv 6xkW13m6q0LcZXt2WCB60NBM8I0Wdamxts0O3HKtoMPgDVOnOWCaSY0U+NRUx4ZJP2e4 Bdcxko6TsopgCaCBIr+1AV27sfQJWNnmeKBDoWC0WFZ14sPE4Aactb2ahL9E0r898Lnx 3EugHIH+0VJEQqBqU1aFr0x/skHpxHuZBTLly+NJfjArMYXBrnAYx3T+QVxdc5Gb4ziO bVcuFPmUduTN3MJqpYmAk4jyRwPcJoiwrnQJ8FVZjtTDjeJTp+onjtjWc/zLUH0sGrNo L8pw== X-Gm-Message-State: AOAM530vYSSK6x0V5nWuxa+MFfolUaoN5xksr4epNfeU11BCWnJdp9Kd oxn1hkcsh8gxHw3SCMxq03bQm2sFdjN8YifNvIFQxFLkDrYzQZEvPME1vg3FQL+VsZC3pN5weeJ FIOsBbyZxx3SssNi1G9kqtTzDfXVKF6pTP89ET7kFYssOt17xmM5zvK1kkw+G X-Received: by 2002:a0c:fd62:: with SMTP id k2mr27266592qvs.51.1617056316529; Mon, 29 Mar 2021 15:18:36 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzYSdTuvzXwSj947y/QWq1Gw7vYl06Ny69njq+aEYPm6whLOz19fdF4mpWlPPYxbKOEA5d8TQ== X-Received: by 2002:a0c:fd62:: with SMTP id k2mr27266568qvs.51.1617056316155; Mon, 29 Mar 2021 15:18:36 -0700 (PDT) Received: from xz-x1.redhat.com (bras-base-toroon474qw-grc-82-174-91-135-175.dsl.bell.ca. [174.91.135.175]) by smtp.gmail.com with ESMTPSA id i17sm12255215qtr.33.2021.03.29.15.18.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 29 Mar 2021 15:18:35 -0700 (PDT) From: Peter Xu To: linux-mm@kvack.org, linux-kernel@vger.kernel.org, linux-man@vger.kernel.org Cc: Axel Rasmussen , peterx@redhat.com, Nadav Amit , Mike Rapoport , Alejandro Colomar , Andrea Arcangeli , Michael Kerrisk , Andrew Morton Subject: [PATCH v5 0/4] man2: udpate mm/userfaultfd manpages to latest Date: Mon, 29 Mar 2021 18:18:29 -0400 Message-Id: <20210329221833.517923-1-peterx@redhat.com> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=peterx@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 0E00C80192E7 X-Stat-Signature: eamqmq86rdibiqjfznpc7mdrsbygn8bw Received-SPF: none (redhat.com>: No applicable sender policy available) receiver=imf27; identity=mailfrom; envelope-from=""; helo=us-smtp-delivery-124.mimecast.com; client-ip=216.205.24.124 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1617056313-334292 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000319, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: v5: - add r-bs for Mike R. - Fix spelling mistake "diable" [Mike R.] - s/Starting from/Since/ for patch 2 (also replaced two existing ones in the same file) [Alex] - s/un-write-protect/write-unprotect/ [Alex] - s/The process was interrupted and need to retry/The process was interrupted; retry this call/ in the last patch. [Alex] v4: - Fixed a few "subordinate clauses" (SC) cases [Alex] - Reword in ioctl_userfaultfd.2 to use bold font for the two modes referenced, so as to be clear on what is "both" referring to [Alex] v3: - Don't use "Currently", instead add "(since x.y)" mark where proper [Alex] - Always use semantic newlines across the whole patchset [Alex] - Use quote when possible, rather than escapes [Alex] - Fix one missing replacement of ".BR" -> ".B" [Alex] - Some other trivial rephrases here and there when fixing up above v2 changes: - Fix wordings as suggested [MikeR] - convert ".BR" to ".B" where proper for the patchset [Alex] - rearrange a few lines in the last two patches where they got messed up - document more things, e.g. UFFDIO_COPY_MODE_WP; and also on how to resolve a wr-protect page fault. There're two features missing in current manpage, namely: (1) Userfaultfd Thread-ID feature (2) Userfaultfd write protect mode There's also a 3rd one which was just contributed from Axel - Axel, I think it would be great if you can add that part too, probably after the whole hugetlbfs/shmem minor mode reaches the linux master branch. Please review, thanks. Peter Xu (4): userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs userfaultfd.2: Add write-protect mode ioctl_userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs ioctl_userfaultfd.2: Add write-protect mode docs man2/ioctl_userfaultfd.2 | 89 +++++++++++++++++++++++++++- man2/userfaultfd.2 | 121 +++++++++++++++++++++++++++++++++++++-- 2 files changed, 203 insertions(+), 7 deletions(-)