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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
# Contributing
## Licensing
Your work is considered a derivative work of the Papers codebase, and
therefore must be licensed as GPLv2+.
You do not need to assign us copyright attribution.
It is our belief that you should always retain copyright on your own work.
When a contribution it's close to being finished, maintainers might amend the
last touches themselves to avoid bikeshedding or endless style nits. You will
keep your authorship on any of those changes.
## Code Style
Papers uses code formatters to increase consistency and simplify development.
Please fix CI code formatting issues, and configure your development environment
to use clang-format for C code, and rustfmt for Rust code.
### Commit messages
The expected format for git commit messages is as follows:
```plain
subsection: short explanation of the commit
Longer explanation explaining exactly what's changed, whether any
external or private interfaces changed, what bugs were fixed (with bug
tracker reference if applicable) and so forth. Be concise but not too
brief.
Closes #1234
```
- Always add a brief description of the commit to the _first_ line of
the commit and terminate by two newlines (it will work without the
second newline, but that is not nice for the interfaces).
- Whenever possible, the first line should include the subsystem of
the papers the commit belongs: `shell`, `libdocument`, `libview`,
`libmisc`, `backends`, `build`, `doc`, `flatpak`.
e.g. “flatpak: bump version of poppler”
- First line (the brief description) must only be one sentence and
should start with a capital letter unless it starts with a lowercase
symbol or identifier. Don't use a trailing period either. Aim to not
exceed 72 characters.
- The main description (the body) is normal prose and should use normal
punctuation and capital letters where appropriate. Consider the commit
message as an email sent to the developers (or yourself, six months
down the line) detailing **why** you changed something. There's no need
to specify the **how**: the changes can be inlined.
- While adding the main description please make sure that individual lines
within the body are no longer than 80 columns, ideally a bit less. This makes
it easier to read without scrolling (both in GitLab as well as a terminal with
the default terminal size).
- When committing code on behalf of others use the `--author` option, e.g.
`git commit -a --author "Joe Coder <joe@coder.org>"` and `--signoff`.
- If your commit is addressing an issue, use the
[GitLab syntax](https://docs.gitlab.com/ce/user/project/issues/automatic_issue_closing.html)
to automatically close the issue when merging the commit with the upstream
repository:
```plain
Closes #1234
Fixes #1234
Closes: https://gitlab.gnome.org/GNOME/gtk/issues/1234
```
- If you have a merge request with multiple commits and none of them
completely fixes an issue, you should add a reference to the issue in
the commit message, e.g. `Bug: #1234`, and use the automatic issue
closing syntax in the description of the merge request.
## Troubleshooting
To enable the debug messages, set the environment variable for the section
you want to debug or set `PPS_DEBUG` to enable debug messages for all sections.
The following sections are available:
```c
PPS_DEBUG_JOBS
PPS_DEBUG_SHOW_BORDERS
```
#### Example
```c
PPS_DEBUG_JOBS=1 papers document.pdf
```
### Asking Development-related questions
If you are working or want to work on Papers, but you bump into
development-related questions, the Papers developers and community are reachable
in the public [Matrix room](https://matrix.to/#/#papers:gnome.org). Do not
hesitate to join and ask questions if you still have any after reading this
document!
### ‘Show borders’ debugging hint
Papers can show a border around the following graphical elements:
* text characters
* links
* form elements
* annotations
* images
* media elements
* selections
this can be very helpful when debugging display issues related to those
elements, to activate it you just need to set two env vars when calling
Papers from a terminal, e.g. to show annotation borders:
```sh
PPS_DEBUG=borders PPS_DEBUG_SHOW_BORDERS=annots papers
```
where `PPS_DEBUG_SHOW_BORDERS` can be set to any of the following values:
`chars` `links` `forms` `annots` `images` `media` `selections`.
If you need to add additional tracing macros to debug a problem, it is
probably a good idea to submit a patch to add them. Chances are someone
else will need to debug stuff in the future.
### Debug Poppler messages
Poppler is the library used by Papers to render PDF documents. When a document
presents error, or there are issues in Poppler to handle it, the output can be
seen by setting `G_MESSAGES_DEBUG` to enable debug messages for Poppler.
#### Example
```
G_MESSAGES_DEBUG=Poppler papers document.pdf
```
or
```
G_MESSAGES_DEBUG=all papers document.pdf
```
### Builder Cannot Run Papers
One of the possible problems that can be encountered when running Papers in
GNOME Builder is missing SDKs or runtimes that were not installed for some reason.
If you encountered similar problem, such as missing `org.gnome.Sdk` or alike:
#### `org.gnome.Sdk//master`
GNOME SDK can be installed from the GNOME Nightly repository, which can be installed with:
```bash
# Papers is built against the current unstable version of GNOME's platform and SDK which is available from its own gnome-nightly repo
flatpak remote-add --user --if-not-exists flathub-beta https://flathub.org/beta-repo/flathub-beta.flatpakrepo
flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak remote-add --user --if-not-exists gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo
```
Finally, you can install it with:
```bash
flatpak install gnome-nightly org.gnome.Sdk//master
```
#### `org.freedesktop.Sdk.Extension.rust-stable//24.08`
Rust Extension of Freedesktop SDK, on the other hand, can be installed from the similar repository
with:
```bash
flatpak install org.freedesktop.Sdk.Extension.rust-stable//24.08
```
|
