Project

General

Profile

Actions
Copy link

Bug #65249

closed

peering_graph.generated.dot renders weird

Added by Zac Dover about 1 month ago. Updated 10 days ago.

Status:
Resolved
Priority:
Normal
Assignee:
Zac Dover
Category:
-
Target version:
-
% Done:

0%

Source:
Tags:
Backport:
Regression:
No
Severity:
3 - minor
Reviewed:
Affected Versions:
ceph-qa-suite:
Pull request ID:
56996
Crash signature (v1):
Crash signature (v2):

Description

The Sample State model graph (peering_graph.generated.dot) in doc/dev/peering.rst is not rendering properly. This was brought to my attention at the end of March 2024 by Laura Flores.

https://docs.ceph.com/en/latest/dev/peering/#generate-a-state-model

Actions
Copy link
 #1

Updated by Zac Dover 13 days ago

dot -Tsvg doc/dev/peering_graph.generated.dot > doc/dev/peering_graph.generated.svg

The above command as of today (19 Apr 2024) generates an SVG image that is 5036x1375px.

Actions
Copy link
 #2

Updated by Zac Dover 13 days ago

size="7,7" in peering_graph_generated.dot causes the peering_graph_generated.svg file to look the (wrong) way that caused me to raise this tracker bug. Replacing "7,7" with "1080,1080" causes the image to render correctly locally.

Actions
Copy link
 #3

Updated by Zac Dover 13 days ago

  • Pull request ID set to 56996
Actions
Copy link
 #4

Updated by Zac Dover 10 days ago

  • Status changed from In Progress to Resolved

I used these instructions to build an SVG file of the peering graph:

$ git clone https://github.com/ceph/ceph.git
$ cd ceph
$ cat src/osd/PeeringState.h src/osd/PeeringState.cc | doc/scripts/gen_state_diagram.py > doc/dev/peering_graph.generated.dot
$ sed -i 's/7,7/1080,1080/' doc/dev/peering_graph.generated.dot
$ dot -Tsvg doc/dev/peering_graph.generated.dot > doc/dev/peering_graph.generated.svg

Then I replaced the ".. graphviz" directive with an ".. image" directive that took the generated file as an argument.

I'll pay the cost of keeping this image manually updated.

Actions
Copy link

Also available in: Atom PDF