From patchwork Fri May 20 14:27:04 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Cole Robinson X-Patchwork-Id: 68246 Delivered-To: patch@linaro.org Received: by 10.140.92.199 with SMTP id b65csp3811380qge; Fri, 20 May 2016 07:30:20 -0700 (PDT) X-Received: by 10.55.125.7 with SMTP id y7mr3699003qkc.3.1463754620003; Fri, 20 May 2016 07:30:20 -0700 (PDT) Return-Path: Received: from mx3-phx2.redhat.com (mx3-phx2.redhat.com. [209.132.183.24]) by mx.google.com with ESMTPS id n69si12399931qke.27.2016.05.20.07.30.18 (version=TLS1 cipher=AES128-SHA bits=128/128); Fri, 20 May 2016 07:30:19 -0700 (PDT) Received-SPF: pass (google.com: domain of libvir-list-bounces@redhat.com designates 209.132.183.24 as permitted sender) client-ip=209.132.183.24; Authentication-Results: mx.google.com; spf=pass (google.com: domain of libvir-list-bounces@redhat.com designates 209.132.183.24 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by mx3-phx2.redhat.com (8.13.8/8.13.8) with ESMTP id u4KERWdW020389; Fri, 20 May 2016 10:27:32 -0400 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id u4KERDSu022322 for ; Fri, 20 May 2016 10:27:13 -0400 Received: from colepc.redhat.com (ovpn-116-14.phx2.redhat.com [10.3.116.14]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u4KERAx6012195; Fri, 20 May 2016 10:27:13 -0400 From: Cole Robinson To: libvirt-list@redhat.com Date: Fri, 20 May 2016 10:27:04 -0400 Message-Id: <04f992b16589e7c8b3302b2ababfcf8465a37f6d.1463754234.git.crobinso@redhat.com> In-Reply-To: References: In-Reply-To: References: X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 2/3] docs: website: drop the static todo list page X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com libvirt.org/todo.html is currently broken: Todo list unavailable: no config file The page is supposed to be auto generated from the bug tracker using todo.pl scripts, but apparently that's broken, and the bug tracking assumptions used by the script were never maintained. A manual run of todo.pl from 2013 was present on the wiki at http://wiki.libvirt.org/page/Todo With some more info explaining that the list isn't any guarantee the RFEs will be included. Drop the broken static page and scripts, and point the sitemap link at the wiki page, which is easier to maintain and to automate using bugzilla queries and RSS --- .gitignore | 1 - TODO | 22 +++------ docs/Makefile.am | 31 ++----------- docs/sitemap.html.in | 2 +- docs/todo.cfg-example | 26 ----------- docs/todo.pl | 125 -------------------------------------------------- 6 files changed, 11 insertions(+), 196 deletions(-) delete mode 100644 docs/todo.cfg-example delete mode 100755 docs/todo.pl -- 2.7.4 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list diff --git a/.gitignore b/.gitignore index 103edc6..c885d84 100644 --- a/.gitignore +++ b/.gitignore @@ -73,7 +73,6 @@ /docs/libvirt-lxc-*.xml /docs/libvirt-qemu-*.xml /docs/libvirt-refs.xml -/docs/todo.html.in /examples/object-events/event-test /examples/dominfo/info1 /examples/domsuspend/suspend diff --git a/TODO b/TODO index 6843a17..c837ce8 100644 --- a/TODO +++ b/TODO @@ -1,22 +1,12 @@ libvirt TODO list ================= -The TODO list changes frequently, so is maintained online -in the libvirt bugzilla +Libvirt does not maintain an authoritative TODO list. However you +can find a list of open feature requests at: - http://bugzilla.redhat.com/ + http://wiki.libvirt.org/page/Todo -Search against +A list of introductory tasks for new contributors is +maintained at: - Product: Virtualization Tools - Component: libvirt - Subject: RFE - -Or browse dependent bugs under - - https://bugzilla.redhat.com/show_bug.cgi?id=libvirtTodo - -Summarized reports automatically generated from bugzilla -and provided online at - - http://libvirt.org/todo.html + http://wiki.libvirt.org/page/BiteSizedTasks diff --git a/docs/Makefile.am b/docs/Makefile.am index 282d101..b5379bf 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -95,14 +95,12 @@ internals_html_in = \ $(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/internals/*.html.in)) internals_html = $(internals_html_in:%.html.in=%.html) -# todo.html is special - it is shipped in the tarball, but we -# have a dedicated 'todo' target to rebuild it from a proper -# config file, all other users are able to build it locally. +# hvsupport.html.in is special, it's automatically generated so we +# list it here explicitly. # For all other files, since we ship pre-built html in the # tarball, we must also ship the sources, even when those # sources are themselves generated. dot_html_in = $(notdir $(wildcard $(srcdir)/*.html.in)) \ - todo.html.in \ hvsupport.html.in dot_html = $(dot_html_in:%.html.in=%.html) @@ -159,7 +157,7 @@ EXTRA_DIST= \ $(patches) $(dot_php_in) $(dot_php_code_in) $(dot_php)\ $(internals_html_in) $(internals_html) \ sitemap.html.in aclperms.htmlinc \ - todo.pl hvsupport.pl todo.cfg-example \ + hvsupport.pl \ $(schema_DATA) acl_generated = aclperms.htmlinc @@ -186,24 +184,6 @@ admin_api: $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml web: $(dot_html) $(internals_html) html/index.html devhelp/index.html \ $(dot_php) -todo.html.in: todo.pl - if [ -f todo.cfg ]; then \ - echo "Generating $@"; \ - $(PERL) $< > $@ \ - || { rm $@ && exit 1; }; \ - else \ - echo "Stubbing $@"; \ - printf "%s\n" \ - "" \ - "" \ - "

Todo list unavailable: no config file

" \ - "" > $@ ; \ - fi - -todo: - rm -f todo.html.in - $(MAKE) todo.html - hvsupport.html: $(srcdir)/hvsupport.html.in $(srcdir)/hvsupport.html.in: $(srcdir)/hvsupport.pl $(api_DATA) \ @@ -213,8 +193,6 @@ $(srcdir)/hvsupport.html.in: $(srcdir)/hvsupport.pl $(api_DATA) \ $(AM_V_GEN)$(PERL) $(srcdir)/hvsupport.pl $(top_srcdir)/src > $@ \ || { rm $@ && exit 1; } -.PHONY: todo - %.png: %.fig convert -rotate 90 $< $@ @@ -336,8 +314,7 @@ clean-local: rm -f *~ *.bak *.hierarchy *.signals *-unused.txt *.html maintainer-clean-local: clean-local - rm -rf $(srcdir)/libvirt-api.xml $(srcdir)/libvirt-refs.xml \ - todo.html.in + rm -rf $(srcdir)/libvirt-api.xml $(srcdir)/libvirt-refs.xml rm -rf $(srcdir)/libvirt-qemu-api.xml $(srcdir)/libvirt-qemu-refs.xml rm -rf $(srcdir)/libvirt-lxc-api.xml $(srcdir)/libvirt-lxc-refs.xml rm -rf $(srcdir)/libvirt-admin-api.xml $(srcdir)/libvirt-admin-refs.xml diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index d5cf723..3ea34b1 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -445,7 +445,7 @@ Security bug reporting and resolution process
  • - Todo list + Todo list Main feature request list
  • diff --git a/docs/todo.cfg-example b/docs/todo.cfg-example deleted file mode 100644 index a99c61a..0000000 --- a/docs/todo.cfg-example +++ /dev/null @@ -1,26 +0,0 @@ -bugzilla = { - #username = ...some email addr... - #password = ...some bz password... - server = https://bugzilla.redhat.com -} -query = { - product = Virtualization Tools - alias = libvirtTodo -} - -output = { - title = Todo list - blurb = <development mailing list. -If you intend to work on one of the items here, it is recommended to -add a comment to the corresponding bugzilla ticket to this effect. -This will reduce the risk of duplicated effort between developers. -It is also strongly recommended to mail the development mailing list -with proposals for new APIs & XML before fully implementing them, to -allow for early design review. -EOF -} diff --git a/docs/todo.pl b/docs/todo.pl deleted file mode 100755 index 36698e8..0000000 --- a/docs/todo.pl +++ /dev/null @@ -1,125 +0,0 @@ -#!/usr/bin/perl - -use strict; -use warnings; - -use BZ::Client; -use BZ::Client::Bug; - -use Config::Record; - -my $cfg = Config::Record->new(file => "todo.cfg"); -my $server = $cfg->get("bugzilla/server", "https://bugzilla.redhat.com"); -my $username = $cfg->get("bugzilla/username"); -my $password = $cfg->get("bugzilla/password"); - -my $product = $cfg->get("query/product", "Virtualization Tools"); -my $todoalias = $cfg->get("query/todoalias", "libvirtTodo"); - -my $title = $cfg->get("output/title", undef); -my $blurb = $cfg->get("output/blurb", undef); - -$SIG{__DIE__} = sub { - my $err = shift; - if (UNIVERSAL::isa($err, "BZ::Client::Exception")) { - die "Unable to access bugzilla: " . $err->message; - } - die $err; -}; - -my $client = BZ::Client->new(url => $server, - user => $username, - password => $password); - -my $todo = BZ::Client::Bug->search($client, {'product' => $product, - 'alias' => $todoalias}); - -die "Cannot find bug alias 'libvirtTodo'" unless $#{$todo} > -1; -my $todoid = $todo->[0]->{'bug_id'}; -my $todosummary = $todo->[0]->{'short_desc'}; -$todosummary =~ s/^\s*RFE\s*:\s*//; -$todosummary =~ s/^\s*\[\s*RFE\s*\]\s*:?\s*//; -$todosummary =~ s/^\s*Tracker\s*:\s*//; - -my $trackers = BZ::Client::Bug->search($client, {'product' => $product, - 'blocked' => $todoid }); - -my @trackers; - -foreach my $tracker (@{$trackers}) { - next if $tracker->{'bug_status'} eq "CLOSED"; - - my $summary = $tracker->{'short_desc'}; - $summary =~ s/^\s*RFE\s*:\s*//; - $summary =~ s/^\s*\[\s*RFE\s*\]\s*:?\s*//; - $summary =~ s/^\s*Tracker\s*:\s*//; - - push @trackers, { - id => $tracker->{'bug_id'}, - summary => $summary, - features => [], - }; -} - -foreach my $tracker (@trackers) { - my $features = BZ::Client::Bug->search($client, {'product' => $product, - 'blocked' => $tracker->{id}}); - - foreach my $feature (@{$features}) { - next if $feature->{'bug_status'} eq "CLOSED"; - - my $summary = $feature->{'short_desc'}; - $summary =~ s/^\s*RFE\s*:\s*//; - $summary =~ s/^\s*\[\s*RFE\s*\]\s*:?\s*//; - - push @{$tracker->{features}}, { - id => $feature->{'bug_id'}, - summary => $summary, - }; - } -} - -sub escape { - my $txt = shift; - $txt =~ s/&/&/g; - $txt =~ s//>/g; - return $txt; -}; - -print "\n"; -print "\n"; -print "\n"; -print " \n"; -if (defined $title) { - print "

    ", &escape($title), "

    \n"; -} else { - print "

    ", &escape($todosummary), "

    \n"; -} -if (defined $blurb) { - print "

    \n"; - print $blurb; - print "

    \n"; -} -foreach my $tracker (sort { $a->{summary} cmp $b->{summary} } @trackers) { - next unless $#{$tracker->{features}} >= 0; - - my $summary = &escape($tracker->{summary}); - my $id = $tracker->{id}; - print "

    $summary

    \n"; - print "
      \n"; - foreach my $feature (sort { $a->{summary} cmp $b->{summary} } @{$tracker->{features}}) { - $summary = &escape($feature->{summary}); - $summary =~ s,^([^:]+):,$1,; - - $id = $feature->{id}; - print "
    • $summary (rhbz $id)
      • \n"; - } - print "
    \n"; -} - -print "

    \n"; -print " This page is automatically generated from ", &escape($todosummary), "\n"; -print "

    \n"; -print " \n"; -print "\n";