Message ID | 20221019093343.9546-1-ilpo.jarvinen@linux.intel.com |
---|---|
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp244077wrs; Wed, 19 Oct 2022 03:32:12 -0700 (PDT) X-Google-Smtp-Source: AMsMyM4kdKBACFC79/4Xq9vTSxNQt6W1+vW0mszyPswH1Zcei5bHpuQcJjWMmOoY3LiNbcZvuX8U X-Received: by 2002:a17:90a:e7c4:b0:20d:451f:a988 with SMTP id kb4-20020a17090ae7c400b0020d451fa988mr8715387pjb.57.1666175532047; Wed, 19 Oct 2022 03:32:12 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666175532; cv=none; d=google.com; s=arc-20160816; b=jFMmMJbTguCJ9+blx1igBz7EGjMNnowytO5e1OB/bdiBu9ysc1NlAv+pFG/Yu/4ZeW k6pi/Nw/AmfV8zzwRz0tb0kU8IiVHVOBW3qqOjX5/rdI0HY6ttc3egaHpYvQ7pAcW7dM Z5Xrs9IEPpbKvbybqRiecrB6fUx3zm/d1I4WzFimaVBMCu3eIzG+PozcqnUUYHytKSkE 1wWW5x43AAP45yIE02fJVoMos4vc7aoZ0BwhpqmyMAOL0SUqTyMc8TAh7vLhXI9XFCYi WL2lD2QCCvKc6wYq+vD7r7jWceFCnnD/ZlDO6MVkIC+o6TEIUQ/O7rGG2AdCLPAYDQKS UTug== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=LbCWPf4vGzuXtfgTLnPOwT6tAizD1J83Tt1sGeB/vwo=; b=T0HuZrFPzKLUuqFY8MbnoiVjSxx/wqzFvVXLr7+YduoebCrTfHNtT6h1t0+CS5iQDB 1OzfSk6J+BXUeSnmLZOLVFUJGkg397pZe/wF66lh5ae/n5nPXTOmXD4r+LLqUGG56dDF my/d3IiG7I3NQaTj7hElVEzx4VFPiC5O9IgIReMQc5GSrqWfWnq+8Kf3tt+S+4N7zJNK +mfXp5lux27vVFVWRknTp9dGHBoETHZzY2zL6Hin9rHm68HbFtDsbFPsd+lnC2aAzl8N 9ytcfqDlQLr1H4//IoJaQZXDOpEJkJUfmYgH9KpaJaDCvHpBtQ3bnwChqE3FZIB32Ndt ftIA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=GXbqsrlv; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id k62-20020a638441000000b00439fbc1b5absi16981267pgd.797.2022.10.19.03.31.51; Wed, 19 Oct 2022 03:32:12 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=GXbqsrlv; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230512AbiJSJ7f (ORCPT <rfc822;samuel.l.nystrom@gmail.com> + 99 others); Wed, 19 Oct 2022 05:59:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33016 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234450AbiJSJ7B (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Wed, 19 Oct 2022 05:59:01 -0400 Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D429B1162CD; Wed, 19 Oct 2022 02:36:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1666172185; x=1697708185; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=1zjPVApNUqKaU7OTFzXOU/zZQjHo3VHZphG8EjiTomo=; b=GXbqsrlvSY1TzbVJiPP5JVA1B9C/Q5yUOgLxKeQEmi5MK2XAYTZAombU 3E9L5sWRpMzYw1t3YgAq82WfzZYZOAOSDQhxzoet95I1UMoIHZ88QwXZD xz+0/i/OurXIxAZhtkvVGUF3TJHYm+mKqX7WKSmJ0nTVIcYWKRIo7bmZJ dXq48/ZGV8qkSjgIesgMcAkkAOQTS7U+YfwYF2JSvw484yyhyUKR0A/5q HsDLGhlw62tHg+KJT6a9mF/3hf8iPisssXHGS9TmynXQVdg1H02NwlN93 RuvJccx9Bk2w+yUwxK0nAqhMSzOQfnUS+OyowQhs7algu8G0We54WqaIC g==; X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="293756489" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="293756489" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:33:56 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="734127822" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="734127822" Received: from sponnura-mobl1.amr.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.251.214.35]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:33:52 -0700 From: =?utf-8?q?Ilpo_J=C3=A4rvinen?= <ilpo.jarvinen@linux.intel.com> To: linux-serial@vger.kernel.org, Greg KH <gregkh@linuxfoundation.org>, Jiri Slaby <jirislaby@kernel.org>, Andy Shevchenko <andriy.shevchenko@linux.intel.com>, Bagas Sanjaya <bagasdotme@gmail.com>, linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, =?utf-8?q?Ilpo_J=C3=A4rvinen?= <ilpo.jarvinen@linux.intel.com> Subject: [PATCH v5 0/5] serial: RS485 kerneldoc/documentation improvements Date: Wed, 19 Oct 2022 12:33:38 +0300 Message-Id: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_MED, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_NONE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1747111675177540760?= X-GMAIL-MSGID: =?utf-8?q?1747111675177540760?= |
Series |
serial: RS485 kerneldoc/documentation improvements
|
|
Message
Ilpo Järvinen
Oct. 19, 2022, 9:33 a.m. UTC
RS485 documentation improvements. While doing the kerneldoc conversion, a few other items came up so they're now included in this series. v5: - Make formatting of names more consistent - serial_rs485::flags bits are: -> The flag bits are: v4: - Remove wrong private: markers - Fix grammar problems v3: - More fixes to kernel doc formatting (thanks to Jiri) - Added a few other related improvements v2: - Include serial_rs485 into documentation - Add * to multi-line flag descriptions Ilpo Järvinen (5): serial: Convert serial_rs485 to kernel doc Documentation: rs485: Link reference properly Documentation: rs485: Mention uart_get_rs485_mode() Documentation: rs485: Fix struct referencing Documentation: Make formatting consistent for rs485 docs .../driver-api/serial/serial-rs485.rst | 56 ++++++++++--------- include/uapi/linux/serial.h | 55 +++++++++++------- 2 files changed, 66 insertions(+), 45 deletions(-)
Comments
On Wed, Oct 19, 2022 at 12:33:38PM +0300, Ilpo Järvinen wrote: > RS485 documentation improvements. While doing the kerneldoc conversion, > a few other items came up so they're now included in this series. > > v5: > - Make formatting of names more consistent > - serial_rs485::flags bits are: -> The flag bits are: > > v4: > - Remove wrong private: markers > - Fix grammar problems > > v3: > - More fixes to kernel doc formatting (thanks to Jiri) > - Added a few other related improvements > > v2: > - Include serial_rs485 into documentation > - Add * to multi-line flag descriptions > > Ilpo Järvinen (5): > serial: Convert serial_rs485 to kernel doc > Documentation: rs485: Link reference properly > Documentation: rs485: Mention uart_get_rs485_mode() > Documentation: rs485: Fix struct referencing > Documentation: Make formatting consistent for rs485 docs > > .../driver-api/serial/serial-rs485.rst | 56 ++++++++++--------- > include/uapi/linux/serial.h | 55 +++++++++++------- > 2 files changed, 66 insertions(+), 45 deletions(-) > The doc LGTM, thanks. For the series, Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>