Commit graph

21 commits

Author SHA1 Message Date
jnqnfe
b683350856 api documentation improvements
includes typo fixes, neatening, addition of more return info, and such.
2017-11-30 00:43:57 +02:00
Ahmed S. Darwish
5d4905ec31 log: Fix compilation error on non-systemd systems
Commit 262bdae0330e used symbols which are only available if systemd
support was compiled in. Fix by using the appropriate #ifdef guards.

Also document the resulting PULSE_LOG_JOURNAL environment variable
behavior if systemd journal support was not compiled in.

[Diwic: changed wording slightly.]

Reported-by: David Henningsson <david.henningsson@canonical.com>
Signed-off-by: Ahmed S. Darwish <darwish.07@gmail.com>
2015-09-25 15:05:43 +03:00
Ahmed S. Darwish
ac5b7b8d5c log: Introduce PULSE_LOG_JOURNAL environment variable
By introducing such an environment variable, applications using the
PA client libraries can configure these libraries to send their logs
directly to the journal.

While client libraries journal logging can be indirectly achieved
using PULSE_LOG_SYSLOG, this pollutes the journal. Meta data gets
replicated twice: once in the journal meta fields and once in the
syslog(3) plain-text message itself.

For attaching any backtraces, also introduce the PA-specific journal
meta field PULSE_BACKTRACE. This is the recommend journal practice
instead of appending any furuther data to the logging message itself.

Signed-off-by: Ahmed S. Darwish <darwish.07@gmail.com>
2015-09-25 17:29:03 +05:30
Ahmed S. Darwish
9d6700f66a pulse: Document client libraries logging behavior
Document how to modify the client libraries logging behvaior
using any of the PA-specific environment variables.

Using the PULSE_LOG_* environment variables makes debugging
and tracing PA applications quite easy, thus the need for an
official documentation text.

Signed-off-by: Ahmed S. Darwish <darwish.07@gmail.com>
2015-08-17 15:21:17 +03:00
Ondrej Holecek
5effc83479 update FSF addresses to FSF web page
FSF addresses used in PA sources are no longer valid and rpmlint
generates numerous warnings during packaging because of this.
This patch changes all FSF addresses to FSF web page according to
the GPL how-to: https://www.gnu.org/licenses/gpl-howto.en.html

Done automatically by sed-ing through sources.
2015-01-14 22:20:40 +02:00
Tanu Kaskinen
b9147fad0f direction: Add a couple of direction helper functions 2014-03-27 10:02:57 +02:00
Peter Meerwald
2da8b1fa63 pulse: Document general error handling. 2012-01-28 15:07:20 +02:00
Maarten Bosmans
231645d4fc Spelling fixes in public headers 2011-08-25 11:27:35 +01:00
Arun Raghavan
c3839c7637 core: Add a pa_format_info structure
This will be used to represent the format of data provided by the client
for both compressed and PCM formats in a new extended API.
2011-05-02 10:17:20 +05:30
Lennart Poettering
4e3f7d5577 doxygen: add rtclock.h to documentation 2009-09-11 01:49:39 +02:00
Maarten Bosmans
8bcb9c6910 various spelling fixes 2009-04-04 02:27:13 +02:00
Lennart Poettering
395523a0bb we don't support glib1.2 anymore 2009-01-15 20:14:58 +01:00
Lennart Poettering
c1f9f95fa2 prepare doxygen docs for 0.9.11 2008-07-21 18:55:17 +02:00
Lennart Poettering
57aee6d59f include proplist.h in pulseaudio.h 2008-06-23 22:46:22 +02:00
Lennart Poettering
8ae83d618e get rid of svn $ keywords 2008-06-18 23:23:21 +03:00
Pierre Ossman
06211b7c8f Add copyright notices to all relevant files. (based on svn log)
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1426 fefdeb5f-60dc-0310-8127-8f9354f1896f
2007-02-13 15:35:19 +00:00
Pierre Ossman
521daf6f0a Huge trailing whitespace cleanup. Let's keep the tree pure from here on,
mmmkay?


git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1418 fefdeb5f-60dc-0310-8127-8f9354f1896f
2007-01-04 13:43:45 +00:00
Lennart Poettering
fe1dadbadd update references to the pkg-config files in the docs
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1038 fefdeb5f-60dc-0310-8127-8f9354f1896f
2006-06-19 23:06:50 +00:00
Lennart Poettering
0d97ac6d2b name the pkg-config files after the library names
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1037 fefdeb5f-60dc-0310-8127-8f9354f1896f
2006-06-19 23:00:21 +00:00
Lennart Poettering
10b5e997d7 replace a few remaining uppercase "Polypaudio" occurences with "PulseAudio"
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1036 fefdeb5f-60dc-0310-8127-8f9354f1896f
2006-06-19 22:11:49 +00:00
Lennart Poettering
25f79693b1 rename polypaudio.h to pulseaudio.h
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1034 fefdeb5f-60dc-0310-8127-8f9354f1896f
2006-06-19 21:55:07 +00:00
Renamed from src/pulse/polypaudio.h (Browse further)