File: README.source

package info (click to toggle)
homer-api 5.0.6+dfsg2-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,604 kB
  • ctags: 2,439
  • sloc: php: 8,259; sql: 1,212; perl: 984; sh: 318; makefile: 69
file content (84 lines) | stat: -rw-r--r-- 3,007 bytes parent folder | download | duplicates (2)
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

Contributions from other developers are welcome, instead of making an
NMU, please consider joining pkg-voip

Whether you are making an NMU or adding yourself in the pkg-voip
team, please make sure any changes you make are tagged and pushed into the
Git repository on alioth before you upload.

uscan
-----

Upstream tags releases with multiple names, e.g. 5.0.5 and 5.0.5-api,
this isn't good for the default uscan configuration.  The regex pattern
in debian/watch has been tweaked to only accept versions ending with a
digit.  Use

   uscan --force-download

to ensure it really downloads.

PostgreSQL or MySQL?
--------------------

upstream provides alternate versions of certain files for MySQL
and PostgreSQL.  Therefore, these are distributed in two
different binary packages.  The user must install only one of these
packages as otherwise files would be overwritten by the other package.
This could be improved upstream to make the choice of database
configurable in a more flexible manner.

apidoc
------

In theory, the apidoc tree should be installed under /usr/share/doc,
possibly as a -doc package.

However, it includes a PHP file, so it is installed in the location
for web content.  Maybe the Makefile could invoke PHP to create
static content so that it can be browsed offline.

Removed JavaScript
------------------

There is a lot of minified JavaScript under apidoc/html/vendor.
For simplicity, it has simply been removed as the package functions
correctly without the apidoc tree.  Most of the dependencies are
actually available as packages, it is necessary to either package
the remaining dependencies or change the upstream code to stop using
some of them.

These are the JavaScript libraries identified in apidoc/html/vendor:

  Available in Debian:
     bootstrap
     jquery.min.js
     lodash.min.js
       https://lodash.com/
       https://packages.debian.org/sid/web/libjs-lodash
     prettify
       https://github.com/google/code-prettify
       https://packages.debian.org/sid/libjs-prettify
     require.min.js
       http://github.com/jrburke/requirejs
       https://packages.qa.debian.org/r/requirejs.html
     path-to-regexp
       https://github.com/pillarjs/path-to-regexp
       https://packages.qa.debian.org/n/node-path-to-regexp.html

  Soon available in Debian:
     diff_match_patch.min.js
       https://code.google.com/p/google-diff-match-patch/
       ITP: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=837746
         uploaded 2016-09-14

  Not yet available in Debian:
     handlebars.min.js
       https://github.com/wycats/handlebars.js/
       https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=779303
       https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=830987
     polyfill.js
       appears to be concatenated examples taken from these pages:
       https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys
       https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf