From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-6.0 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=unavailable autolearn_force=no version=3.4.2 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id 187527D04D for ; Mon, 14 Jan 2019 09:01:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725837AbfANJBL (ORCPT ); Mon, 14 Jan 2019 04:01:11 -0500 Received: from mx0b-001b2d01.pphosted.com ([148.163.158.5]:50864 "EHLO mx0a-001b2d01.pphosted.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726064AbfANJBL (ORCPT ); Mon, 14 Jan 2019 04:01:11 -0500 Received: from pps.filterd (m0098417.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id x0E8w3SA042245 for ; Mon, 14 Jan 2019 04:01:10 -0500 Received: from e06smtp05.uk.ibm.com (e06smtp05.uk.ibm.com [195.75.94.101]) by mx0a-001b2d01.pphosted.com with ESMTP id 2q0n1fwsgr-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 14 Jan 2019 04:01:09 -0500 Received: from localhost by e06smtp05.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 14 Jan 2019 09:01:08 -0000 Received: from b06cxnps3074.portsmouth.uk.ibm.com (9.149.109.194) by e06smtp05.uk.ibm.com (192.168.101.135) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 14 Jan 2019 09:01:05 -0000 Received: from d06av21.portsmouth.uk.ibm.com (d06av21.portsmouth.uk.ibm.com [9.149.105.232]) by b06cxnps3074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id x0E914Iq49152158 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 14 Jan 2019 09:01:04 GMT Received: from d06av21.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 17ECF52065; Mon, 14 Jan 2019 09:01:04 +0000 (GMT) Received: from tal (unknown [9.148.32.96]) by d06av21.portsmouth.uk.ibm.com (Postfix) with ESMTPS id 862065204F; Mon, 14 Jan 2019 09:01:02 +0000 (GMT) Received: by tal (sSMTP sendmail emulation); Mon, 14 Jan 2019 11:01:01 +0200 From: Joel Nider To: Jonathan Corbet Cc: Jason Gunthorpe , Leon Romanovsky , Doug Ledford , Mike Rapoport , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: updating user verbs documentation Date: Mon, 14 Jan 2019 11:00:48 +0200 X-Mailer: git-send-email 2.7.4 X-TM-AS-GCONF: 00 x-cbid: 19011409-0020-0000-0000-0000030628D4 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 19011409-0021-0000-0000-0000215738F6 Message-Id: <1547456451-7102-1-git-send-email-joeln@il.ibm.com> Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7BIT MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:,, definitions=2019-01-14_05:,, signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=860 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1901140076 Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org A small patchset to update the verbs API documentation with some information regarding the ioctl syscall. First patch converts the file format to ReST, since this is the new preferred format. 2nd patch links this file to the main index so we can actually find it by browsing (search will work in any case). 3rd patch adds the new content, documenting a bit of the internal workings of the kernel side of the API functions. The goal is to make it easier for developers unfamiliar with the structure to understand what is going on when adding a new function. [PATCH 1/3] docs-rst: infiniband: Convert user verbs doc to rst [PATCH 2/3] docs-rst: update index file with infiniband docs [PATCH 3/3] docs-rst: infiniband: update verbs API details