public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: devel@edk2.groups.io
Cc: Ray Ni <ray.ni@intel.com>, Bob Feng <bob.c.feng@intel.com>,
	Liming Gao <liming.gao@intel.com>,
	Sean Brogan <sean.brogan@microsoft.com>,
	Bret Barkelew <Bret.Barkelew@microsoft.com>
Subject: [Patch 0/1] BaseTools/Scripts: Add package dependency graphing tool
Date: Fri, 13 Dec 2019 11:44:48 -0800	[thread overview]
Message-ID: <20191213194449.7036-1-michael.d.kinney@intel.com> (raw)

https://bugzilla.tianocore.org/show_bug.cgi?id=2161

Add python script that recursively scans a directory for EDK II
packages and generates GraphViz dot input that is used to render
a graph of package dependencies in SVG format.

Detects following error/warning conditions:
* Ambiguous dependencies (multiple matches)
* Unresolved dependencies
* Circular dependencies
* Nested packages

Links to sample graphs

https://github.com/mdkinney/edk2/wiki/images/edk2.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/edk2-SkipPlatforms.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/edk2-SkipPlatformsAndArm.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/edk2-platforms.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/edk2-platforms-HideUnresolved.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/edk2-platforms-AddBinariesHideUnresolved.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/edk2-non-osi.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/FSP.svg?sanitize=true
https://github.com/mdkinney/edk2/wiki/images/all.svg?sanitize=true

This patch is available for review at the following branch:

https://github.com/mdkinney/edk2/tree/Bug_2161_PackageDependencyGraph

A proposed update to the EDK II Packages wiki page that adds details on 
package dependency rules that this tool can help to visualize and resolve
issues.

https://github.com/mdkinney/edk2/wiki/EDKII-Packages

A new wiki page with graphs from the current EDK II repos and instructions
on how to use this new script to generate the graphs.  Complex graphs can be
saved locally and viewed with an SVG viewer.

https://github.com/mdkinney/edk2/wiki/EDK-II-Package-Dependency-Graphs


Cc: Ray Ni <ray.ni@intel.com>
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>

Michael D Kinney (1):
  BaseTools/Scripts: Add package dependency graphing tool

 BaseTools/Scripts/PackageDependencyGraph.py | 296 ++++++++++++++++++++
 1 file changed, 296 insertions(+)
 create mode 100644 BaseTools/Scripts/PackageDependencyGraph.py

-- 
2.21.0.windows.1


             reply	other threads:[~2019-12-13 19:44 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-13 19:44 Michael D Kinney [this message]
2019-12-13 19:44 ` [Patch 1/1] BaseTools/Scripts: Add package dependency graphing tool Michael D Kinney
2019-12-16  5:56   ` Ni, Ray
     [not found]   ` <15E0C4623803B81C.31060@groups.io>
2019-12-16  8:40     ` [edk2-devel] " Ni, Ray
2019-12-16  8:48       ` Steven Shi
2019-12-16 17:16         ` Michael D Kinney
2019-12-16 19:45           ` Sean
2019-12-17  2:48             ` Ni, Ray
2019-12-17 16:10               ` Steven Shi
2019-12-19  1:11           ` Steven Shi
2019-12-16 17:14       ` Michael D Kinney
2019-12-17  2:53         ` Ni, Ray

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191213194449.7036-1-michael.d.kinney@intel.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox