From patchwork Tue Oct 19 09:03:40 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Kashyap Chamarthy X-Patchwork-Id: 12569195 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5AA73C433EF for ; Tue, 19 Oct 2021 09:06:45 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 0073660FED for ; Tue, 19 Oct 2021 09:06:44 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0073660FED Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:55420 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mcl51-0003Hk-Qi for qemu-devel@archiver.kernel.org; Tue, 19 Oct 2021 05:06:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50656) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mcl2Z-0000v7-Rw for qemu-devel@nongnu.org; Tue, 19 Oct 2021 05:04:11 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:20021) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mcl2X-0006Ve-AG for qemu-devel@nongnu.org; Tue, 19 Oct 2021 05:04:11 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1634634247; 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: in-reply-to:in-reply-to:references:references; bh=4nv7AXTh09QGlEnyMGAR5DJ9aoGOvs7/rWd9h2sq6p4=; b=anNItmUR50+n360WJttSlRXzC/jD4xxRjoDsHpe2hp5Zfz9HrDK43fo4dMmmusghRNca90 Pd2MFX/ljJlhgf633kodKbqvF5p27tt+k7kwJqkYH85zgSYyWfRcus+Gc5RVvRYFtpTWDc o3mt/gpLZrFCMegaf2LBYjtFaXK37Dw= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-153-54r5FwCjN7OUXfT7cEEstQ-1; Tue, 19 Oct 2021 05:04:04 -0400 X-MC-Unique: 54r5FwCjN7OUXfT7cEEstQ-1 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 0DD211006AAA; Tue, 19 Oct 2021 09:04:03 +0000 (UTC) Received: from paraplu.home (unknown [10.39.194.235]) by smtp.corp.redhat.com (Postfix) with ESMTP id 56E6970951; Tue, 19 Oct 2021 09:04:00 +0000 (UTC) From: Kashyap Chamarthy To: qemu-devel@nongnu.org Subject: [PATCH v2 2/6] docs: rSTify the "SpellCheck" wiki Date: Tue, 19 Oct 2021 11:03:40 +0200 Message-Id: <20211019090344.3054300-3-kchamart@redhat.com> In-Reply-To: <20211019090344.3054300-1-kchamart@redhat.com> References: <20211019090344.3054300-1-kchamart@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=kchamart@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Received-SPF: pass client-ip=216.205.24.124; envelope-from=kchamart@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -28 X-Spam_score: -2.9 X-Spam_bar: -- X-Spam_report: (-2.9 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.049, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Peter Maydell , Thomas Huth , Kashyap Chamarthy , qemu-trivial@nongnu.org, Eric Blake , Michael Tokarev , Laurent Vivier , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Stefan Hajnoczi , Paolo Bonzini , John Snow Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" The original wiki is here[1]. I converted by copying the wiki source into a .wiki file and convert to rST using `pandoc`: $ pandoc -f Mediawiki -t rst spell-check.wiki -o spell-check.rst As part of this rST converstion, I've removed the dated and `codespell` invocations, and linked to the GitHub repo. And cleaned up a couple of external URLs. [1] https://wiki.qemu.org/Contribute/SpellCheck Signed-off-by: Kashyap Chamarthy Reviewed-by: Philippe Mathieu-Daudé --- docs/devel/spell-check.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/devel/spell-check.rst diff --git a/docs/devel/spell-check.rst b/docs/devel/spell-check.rst new file mode 100644 index 0000000000..61275b73c2 --- /dev/null +++ b/docs/devel/spell-check.rst @@ -0,0 +1,20 @@ +Spell Check +=========== + +QEMU uses British or American English in code and documentation. There +are some typical spelling bugs which can be easily avoided by using +tools like ``codespell``. + +`codespell `__ is a +Python script which detects (and optionally fixes) the most common +spelling bugs. It is packaged for most common Linux distributions. + +.. _external_links: + +External Links +-------------- + +- A spell-check tool for Emacs users: + https://github.com/stsquad/my-emacs-stuff/blob/master/my-spell.el +- http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines +- http://grammar.yourdictionary.com/spelling-and-word-lists/misspelled.html