From patchwork Wed Nov 7 18:02:19 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Engestrom X-Patchwork-Id: 10672821 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id CC3071709 for ; Wed, 7 Nov 2018 18:02:28 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id BD7CD2CC3B for ; Wed, 7 Nov 2018 18:02:28 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B156B2CCEE; Wed, 7 Nov 2018 18:02:28 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 8E3222CC3B for ; Wed, 7 Nov 2018 18:02:27 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id A19BE6E3CD; Wed, 7 Nov 2018 18:02:26 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by gabe.freedesktop.org (Postfix) with ESMTPS id 150EF6E3CD for ; Wed, 7 Nov 2018 18:02:26 +0000 (UTC) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Nov 2018 10:02:25 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.54,476,1534834800"; d="scan'208";a="89340277" Received: from hhalland-mobl1.ger.corp.intel.com (HELO eengestr-dev.ger.corp.intel.com) ([10.252.9.70]) by orsmga006.jf.intel.com with ESMTP; 07 Nov 2018 10:02:24 -0800 From: Eric Engestrom To: dri-devel@lists.freedesktop.org Subject: [PATCH libdrm] README: reflow the project description to improve readability Date: Wed, 7 Nov 2018 18:02:19 +0000 Message-Id: <20181107180219.27053-1-eric.engestrom@intel.com> X-Mailer: git-send-email 2.19.1 MIME-Version: 1.0 Organization: Intel Corp UK X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP Also, move the sentence about "who would use libdrm" into its own paragraph, as it is something people discovering libdrm will want to know. Signed-off-by: Eric Engestrom Reviewed-by: Emil Velikov --- README.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index f3df9ac193018f6a63e9..e47cb241b119d09b642d 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,17 @@ libdrm - userspace library for drm +---------------------------------- -This is libdrm, a userspace library for accessing the DRM, direct -rendering manager, on Linux, BSD and other operating systems that -support the ioctl interface. The library provides wrapper functions -for the ioctls to avoid exposing the kernel interface directly, and -for chipsets with drm memory manager, support for tracking relocations -and buffers. libdrm is a low-level library, typically used by -graphics drivers such as the Mesa DRI drivers, the X drivers, libva -and similar projects. New functionality in the kernel DRM drivers -typically requires a new libdrm, but a new libdrm will always work -with an older kernel. +This is libdrm, a userspace library for accessing the DRM, direct rendering +manager, on Linux, BSD and other operating systems that support the ioctl +interface. +The library provides wrapper functions for the ioctls to avoid exposing the +kernel interface directly, and for chipsets with drm memory manager, support +for tracking relocations and buffers. +New functionality in the kernel DRM drivers typically requires a new libdrm, +but a new libdrm will always work with an older kernel. + +libdrm is a low-level library, typically used by graphics drivers such as +the Mesa drivers, the X drivers, libva and similar projects. Compiling