From mboxrd@z Thu Jan 1 00:00:00 1970 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=-15.0 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 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 B3063C433DB for ; Wed, 24 Feb 2021 12:20:54 +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 17F9064EC3 for ; Wed, 24 Feb 2021 12:20:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 17F9064EC3 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:40412 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lEt9w-0007CJ-Vk for qemu-devel@archiver.kernel.org; Wed, 24 Feb 2021 07:20:52 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34166) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lEt8q-0006lS-CW for qemu-devel@nongnu.org; Wed, 24 Feb 2021 07:19:44 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:52947) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1lEt8o-0006sq-8p for qemu-devel@nongnu.org; Wed, 24 Feb 2021 07:19:44 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1614169180; h=from:from:reply-to: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=XRsxIOUI7a+T3ZWnEj4ZC9mi3WSK0vu8SrIrctvlX10=; b=awfDA1/ruN1viL0oaoC4uP/NYU9JdQ18YX1iZLH6HhRFcFh1Py2tQJoVzy9J2NkN7LDLeu jziCT9gCEHWQAXrRlypuUJvLFFrsQz3Gx02J86QFPOWgmIRsltvaFxnM928wSPkpIBetA4 KZ6bn2Aab1gl/JfnIQQMwO1x3GQCzDA= 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-247-fu2Y-VudNlecJdwbXtGggQ-1; Wed, 24 Feb 2021 07:19:36 -0500 X-MC-Unique: fu2Y-VudNlecJdwbXtGggQ-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 77A08801977; Wed, 24 Feb 2021 12:19:35 +0000 (UTC) Received: from redhat.com (ovpn-115-119.ams2.redhat.com [10.36.115.119]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 4E8F360916; Wed, 24 Feb 2021 12:19:28 +0000 (UTC) Date: Wed, 24 Feb 2021 12:19:25 +0000 From: Daniel =?utf-8?B?UC4gQmVycmFuZ8Op?= To: Stefan Hajnoczi Subject: Re: [PATCH] docs: move CODING_STYLE into the developer documentation Message-ID: References: <20210223095931.16908-1-alex.bennee@linaro.org> <2ee6c3b3-7b90-e10c-8950-bfd07c963558@redhat.com> <5a1c4191-b0e6-8dcf-d5db-7335b5f41628@redhat.com> <87lfbe51oy.fsf@linaro.org> MIME-Version: 1.0 In-Reply-To: User-Agent: Mutt/2.0.5 (2021-01-21) X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=berrange@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=216.205.24.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, 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_H3=0.001, RCVD_IN_MSPIKE_WL=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: , Reply-To: Daniel =?utf-8?B?UC4gQmVycmFuZ8Op?= Cc: Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Thomas Huth , Alex =?utf-8?Q?Benn=C3=A9e?= , QEMU Developers , Peter Maydell Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On Wed, Feb 24, 2021 at 12:15:05PM +0000, Stefan Hajnoczi wrote: > On Tue, Feb 23, 2021 at 01:37:45PM +0000, Alex Bennée wrote: > > > > Philippe Mathieu-Daudé writes: > > > > > On 2/23/21 12:29 PM, Philippe Mathieu-Daudé wrote: > > >> On 2/23/21 12:07 PM, Peter Maydell wrote: > > >>> On Tue, 23 Feb 2021 at 10:02, Alex Bennée wrote: > > >>>> > > >>>> There is no particular reason to keep this on it's own in the root of > > >>>> the tree. Move it into the rest of the fine developer manual and fixup > > >>>> any links to it. The only tweak I've made is to fix the code-block > > >>>> annotations to mention the language C. > > >>>> > > >>>> Signed-off-by: Alex Bennée > > >>>> --- > > >>>> diff --git a/README.rst b/README.rst > > >>>> index ce39d89077..f5d41e59b1 100644 > > >>>> --- a/README.rst > > >>>> +++ b/README.rst > > >>>> @@ -66,7 +66,9 @@ When submitting patches, one common approach is to use 'git > > >>>> format-patch' and/or 'git send-email' to format & send the mail to the > > >>>> qemu-devel@nongnu.org mailing list. All patches submitted must contain > > >>>> a 'Signed-off-by' line from the author. Patches should follow the > > >>>> -guidelines set out in the CODING_STYLE.rst file. > > >>>> +guidelines set out in the `style section > > >>>> +` of > > >>>> +the Developers Guide. > > >>> > > >>> This is the first instance of a qemu.readthedocs.io URL in the > > >>> tree. Do we really want to have our references to our documentation > > >>> be to a third party website ? > > >> > > >> We can use https://www.qemu.org/docs/master/devel/style.html: > > >> > > >> $ curl https://www.qemu.org/docs/master/devel/style.html > > >> > > >> > > >> 302 Found > > >> > > >>

Found

> > >>

The document has moved > >> href="https://qemu.readthedocs.io/en/latest/devel/style.html">here.

> > >> > > > > I think if we treat the qemu.org domain as being the canonical URL and > > then let it redirect where it wants. > > Yes, let's treat qemu.org as the canonical domain so we have the ability > to change locations easily later. > > > > Or even better since we have a job pushing to Gitlab pages > > > accessible on https://qemu-project.gitlab.io/qemu/: > > > > > > https://qemu-project.gitlab.io/qemu/devel/style.html > > > > > > Maybe the https://www.qemu.org/docs/ redirect should > > > go to gitlab page now? > > > > It could do either, I think the result is exactly the same. > > Standarizing project infrastructure on GitLab CI seems good to me. That > way developers will be able to reuse their CI knowledge and won't have > to learn other systems (like readthedocs). > > However, I don't see .gitlab-ci.yml directives that build the docs and > publish a static page yet. Is anyone volunteering to do this? (It can be > done as a separate step from this patch.) The very last job (called 'pages') in .gitlab-ci.yml does this. Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|