Mercurial > p > roundup > code
comparison doc/upgrading.txt @ 7797:8bdf0484215c
Summary: feat: roundup-admin history command has human interpretable output
Reformat journal entries and make try to make readable sentences out
of them.
Set up translation markers and added hints for the tanslators by
marking translator comments with;
# .Hint text for translator
on the line before _() markers.
Doc'ed changes in roundup-admin docs and added info to upgrading.txt.
If the user wants old format, they can call
history designator raw
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 10 Mar 2024 21:59:20 -0400 |
| parents | 72a26f3b94db |
| children | af898d1d66dc |
comparison
equal
deleted
inserted
replaced
| 7796:5f3b49bb7742 | 7797:8bdf0484215c |
|---|---|
| 267 | 267 |
| 268 before changing your PostgreSQL configuration, try changing the pragma | 268 before changing your PostgreSQL configuration, try changing the pragma |
| 269 ``savepoint_limit`` to a lower value. By default it is set to | 269 ``savepoint_limit`` to a lower value. By default it is set to |
| 270 ``10000``. In some cases this may be too high. See the `administration | 270 ``10000``. In some cases this may be too high. See the `administration |
| 271 guide`_ for further details. | 271 guide`_ for further details. |
| 272 | |
| 273 roundup-admin's History Command Produces Readable Output | |
| 274 -------------------------------------------------------- | |
| 275 | |
| 276 The history command of roundup-admin used to print the raw journal | |
| 277 data. In this release the default is to produce more human readable | |
| 278 data. The original output (not pretty printed as below) was:: | |
| 279 | |
| 280 [('1', <Date 2013-02-18.20:30:34.125>, '1', 'create', {}), | |
| 281 ('1', | |
| 282 <Date 2013-02-19.21:24:20.391>, | |
| 283 '1', | |
| 284 'set', | |
| 285 {'messages': (('+', ['3']),)}), | |
| 286 ('1', <Date 2013-02-19.21:24:24.797>, '1', 'set', {'priority': '1'}), | |
| 287 ('1', | |
| 288 <Date 2013-02-20.03:16:52.000>, | |
| 289 '1', | |
| 290 'link', | |
| 291 ('issue', '2', 'dependson')), | |
| 292 ('1', <Date 2013-02-21.20:51:40.750>, '1', 'link', ('issue', '2', | |
| 293 'seealso')), | |
| 294 ('1', | |
| 295 <Date 2013-02-22.05:33:08.875>, | |
| 296 '1', | |
| 297 'set', | |
| 298 {'dependson': (('+', ['3']),), 'private': None, 'queue': None}), | |
| 299 ('1', | |
| 300 <Date 2013-02-22.05:33:19.406>, | |
| 301 '1', | |
| 302 'set', | |
| 303 {'dependson': (('+', ['2']),)}), | |
| 304 ('1', | |
| 305 <Date 2013-02-27.03:24:42.844>, | |
| 306 '1', | |
| 307 'unlink', | |
| 308 ('issue', '2', 'seealso')), | |
| 309 ... | |
| 310 | |
| 311 Now it produces (Each entry is on one line, lines wrapped | |
| 312 and indented for display):: | |
| 313 | |
| 314 admin(2013-02-18.20:30:34) create issue | |
| 315 admin(2013-02-19.21:24:20) set modified messages: added: msg3 | |
| 316 admin(2013-02-19.21:24:24) set priority was critical(1) | |
| 317 admin(2013-02-20.03:16:52) link added issue2 to dependson | |
| 318 admin(2013-02-21.20:51:40) link added issue2 to seealso | |
| 319 admin(2013-02-22.05:33:08) set modified dependson: added: issue3; | |
| 320 private was None; queue was None | |
| 321 admin(2013-02-22.05:33:19) set modified dependson: added: issue2 | |
| 322 admin(2013-02-27.03:24:42) unlink removed issue2 from seealso | |
| 323 ... | |
| 324 | |
| 325 | |
| 326 A few things to note: set operations can either assign a property or | |
| 327 report a modification of a multilink property. If an assignment | |
| 328 occurs, the value reported is the **old value** that was there before | |
| 329 the assignment. It is **not** the value that is assigned. In the | |
| 330 example above I don't know what the current value of priority is. All | |
| 331 I know it was set to critical when the issue was created. | |
| 332 | |
| 333 Modifications to multilink properties work differently. I know that | |
| 334 ``msg3`` was present in the messages property after 2013-02-19 at | |
| 335 21:24:20 UTC. | |
| 336 | |
| 337 The history command gets a new optional argument ``raw`` that produces | |
| 338 the old style output. The old style is (marginally) more useful for | |
| 339 script automation. | |
| 272 | 340 |
| 273 .. index:: Upgrading; 2.2.0 to 2.3.0 | 341 .. index:: Upgrading; 2.2.0 to 2.3.0 |
| 274 | 342 |
| 275 Migrating from 2.2.0 to 2.3.0 | 343 Migrating from 2.2.0 to 2.3.0 |
| 276 ============================= | 344 ============================= |