1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
Development guide for librsvg
=============================
.. toctree::
:caption: For Distributors and End Users
:maxdepth: 1
product
features
roadmap
compiling
security
bugs
.. toctree::
:caption: Getting Started as a Contributor
:maxdepth: 1
devel_environment
contributing
.. toctree::
:caption: Understand the Code
:maxdepth: 1
architecture
adding_a_property
memory_leaks
.. toctree::
:caption: Design Documents
:maxdepth: 1
text_layout
render_tree
api_observability
performance_tracking
.. toctree::
:caption: Info for Maintainers
:maxdepth: 1
releasing
ci
Welcome to the developer's guide for librsvg. This is for people who
want to work on the development of librsvg itself, not for users of
the library or the `rsvg-convert` program.
If you want to modify this document, `please see its source code
<https://gitlab.gnome.org/GNOME/librsvg/-/tree/main/devel-docs>`_.
Introduction
------------
Librsvg is a project with a long history; it started 2001 as a way to
use the then-new Scalable Vector Graphics format (SVG) for GNOME's
icons and other graphical assets on the desktop. Since then, it has
evolved into a few different tools.
- :doc:`product` - What comes out of this repository once it is compiled?
- :doc:`features` - Supported elements, attributes, and properties.
- :doc:`roadmap` - Ever-changing list of priorities for the
maintainers; check this often!
- :doc:`compiling` - Cross compilation, debug/release builds, special options.
- :doc:`security` - Reporting security bugs, releases with security
fixes, security of dependencies.
- :doc:`bugs`
Getting started
---------------
- :doc:`devel_environment`
- :doc:`contributing`
Understand the code
-------------------
Test suite - move tests/readme here?
- `Documentation of the library's internals <https://gnome.pages.gitlab.gnome.org/librsvg/internals/rsvg/index.html>`_
- :doc:`architecture`
- :doc:`adding_a_property`
- :doc:`memory_leaks`
Design documents
----------------
Before embarking on big changes to librsvg, please write a little
design document modeled on the following ones, and submit a merge
request. We can then discuss it before coding. This way we will have
a sort of big-picture development history apart from commit messages.
- :doc:`text_layout`
- :doc:`render_tree`
- :doc:`api_observability`
- :doc:`performance_tracking`
See https://rustc-dev-guide.rust-lang.org/walkthrough.html, section
Overview, to formalize the RFC process for features vs. drive-by
contributions.
Information for maintainers
---------------------------
- :doc:`releasing`
- :doc:`ci`
Overview of the maintainer's workflow.
Marge-bot.
Documentation on the CI.
References
----------
- `SVG2 specification <https://www.w3.org/TR/SVG2/>`_. This is the current Candidate Recommendation and it should
be your main reference...
- ... except for things which are later clarified in the `SVG2 Editor's Draft <https://svgwg.org/svg2-draft/>`_.
- `Filter Effects Module Level 1 <https://www.w3.org/TR/filter-effects/>`_.
- `References listed in the SVG2 spec
<https://www.w3.org/TR/SVG2/refs.html>`_ - if you need to consult
the CSS specifications.
- `SVG1.1 specification <https://www.w3.org/TR/SVG11/>`_. Use this mostly for historical reference.
- `SVG Working Group repository
<https://github.com/w3c/svgwg/tree/master>`_. The github issues are
especially interesting. Use this to ask for clarifications of the
spec.
- `SVG Working Group page <https://svgwg.org/>`_.
- Presentation at GUADEC 2017, `Replacing C library code with Rust: What I learned with
librsvg <https://viruta.org/docs/fmq-porting-c-to-rust.pdf>`_. It gives
a little history of librsvg, and how/why it was being ported to Rust
from C.
- Presentation at GUADEC 2018, `Patterns of refactoring C to Rust: the case of
librsvg <https://viruta.org/docs/fmq-refactoring-c-to-rust.pdf>`_. It
describes ways in which librsvg's C code was refactored to allow
porting it to Rust.
- `Federico Mena's blog posts on librsvg
<https://viruta.org/tag/librsvg.html>`_ - plenty of of history and
stories from the development process.
Talks on librsvg.
|
