Fossil SCM
Attempt to clarify the documentation of the /tarball URI.
Commit
7cd1ebd093a47d2d2ffdb0ce5b9ac4159b86f9b1aff19f731c412dfcaccce49c
Parent
1eb545a1408e6c2…
1 file changed
+23
-20
+23
-20
| --- src/tar.c | ||
| +++ src/tar.c | ||
| @@ -704,39 +704,42 @@ | ||
| 704 | 704 | return zName; |
| 705 | 705 | } |
| 706 | 706 | |
| 707 | 707 | /* |
| 708 | 708 | ** WEBPAGE: tarball |
| 709 | -** URL: /tarball | |
| 710 | -** | |
| 711 | -** Generate a compressed tarball for the check-in specified by the "r" | |
| 712 | -** query parameter. Return that compressed tarball as the HTTP reply | |
| 713 | -** content. | |
| 714 | -** | |
| 715 | -** The r= and name= query parameters can be specified as extensions to the | |
| 716 | -** URI. Example, the following URIs are all equivalent: | |
| 709 | +** URL: /tarball/VERSION/NAME.tar.gz | |
| 710 | +** | |
| 711 | +** Generate a compressed tarball for the check-in specified by VERSION. | |
| 712 | +** The tarball is called NAME.tar.gz and has a top-level directory called | |
| 713 | +** NAME. | |
| 714 | +** | |
| 715 | +** Alternatively, the VERSION can be specified using the r= query parameter. | |
| 716 | +** All of the following URLs are equivalent: | |
| 717 | 717 | ** |
| 718 | 718 | ** /tarball/release/xyz.tar.gz |
| 719 | 719 | ** /tarball?r=release&name=xyz.tar.gz |
| 720 | 720 | ** /tarball/xyz.tar.gz?r=release |
| 721 | 721 | ** /tarball?name=release/xyz.tar.gz |
| 722 | 722 | ** |
| 723 | 723 | ** Query parameters: |
| 724 | 724 | ** |
| 725 | -** name=NAME[.tar.gz] The base name of the output file. The default | |
| 726 | -** value is a configuration parameter in the project | |
| 727 | -** settings. A prefix of the name, omitting the | |
| 728 | -** extension, is used as the top-most directory name. | |
| 725 | +** name=[CKIN/]NAME The optional CKIN component of the name= parameter | |
| 726 | +** identifies the check-in from which the tarball is | |
| 727 | +** constructed. If CKIN is omitted and there is no | |
| 728 | +** r= query parameter, then use "trunk". NAME is the | |
| 729 | +** name of the download file. The top-level directory | |
| 730 | +** in the generated tarball is called by NAME with the | |
| 731 | +** file extension removed. | |
| 729 | 732 | ** |
| 730 | -** r=TAG The check-in that is turned into a compressed tarball. | |
| 731 | -** Defaults to "trunk". This query parameter used to | |
| 732 | -** be called "uuid" and "uuid" is still accepted for | |
| 733 | -** backwards compatibility. If the name= query parameter | |
| 734 | -** contains one "/" character then the part before the / | |
| 735 | -** is the TAG and the part after the / is the true name. | |
| 736 | -** If no TAG is specified by any of the above means, then | |
| 737 | -** "trunk" is used as the default. | |
| 733 | +** r=TAG TAG identifies the check-in that is turned into a | |
| 734 | +** compressed tarball. The default value is "trunk". | |
| 735 | +** If r= is omitted and if the name= query parameter | |
| 736 | +** contains one "/" character then the of part the | |
| 737 | +** name= value before the / becomes the TAG and the | |
| 738 | +** part of the name= value after the / is the download | |
| 739 | +** filename. If no check-in is specified by either | |
| 740 | +** name= or r=, then "trunk" is used. | |
| 738 | 741 | ** |
| 739 | 742 | ** in=PATTERN Only include files that match the comma-separate |
| 740 | 743 | ** list of GLOB patterns in PATTERN, as with ex= |
| 741 | 744 | ** |
| 742 | 745 | ** ex=PATTERN Omit any file that match PATTERN. PATTERN is a |
| 743 | 746 |
| --- src/tar.c | |
| +++ src/tar.c | |
| @@ -704,39 +704,42 @@ | |
| 704 | return zName; |
| 705 | } |
| 706 | |
| 707 | /* |
| 708 | ** WEBPAGE: tarball |
| 709 | ** URL: /tarball |
| 710 | ** |
| 711 | ** Generate a compressed tarball for the check-in specified by the "r" |
| 712 | ** query parameter. Return that compressed tarball as the HTTP reply |
| 713 | ** content. |
| 714 | ** |
| 715 | ** The r= and name= query parameters can be specified as extensions to the |
| 716 | ** URI. Example, the following URIs are all equivalent: |
| 717 | ** |
| 718 | ** /tarball/release/xyz.tar.gz |
| 719 | ** /tarball?r=release&name=xyz.tar.gz |
| 720 | ** /tarball/xyz.tar.gz?r=release |
| 721 | ** /tarball?name=release/xyz.tar.gz |
| 722 | ** |
| 723 | ** Query parameters: |
| 724 | ** |
| 725 | ** name=NAME[.tar.gz] The base name of the output file. The default |
| 726 | ** value is a configuration parameter in the project |
| 727 | ** settings. A prefix of the name, omitting the |
| 728 | ** extension, is used as the top-most directory name. |
| 729 | ** |
| 730 | ** r=TAG The check-in that is turned into a compressed tarball. |
| 731 | ** Defaults to "trunk". This query parameter used to |
| 732 | ** be called "uuid" and "uuid" is still accepted for |
| 733 | ** backwards compatibility. If the name= query parameter |
| 734 | ** contains one "/" character then the part before the / |
| 735 | ** is the TAG and the part after the / is the true name. |
| 736 | ** If no TAG is specified by any of the above means, then |
| 737 | ** "trunk" is used as the default. |
| 738 | ** |
| 739 | ** in=PATTERN Only include files that match the comma-separate |
| 740 | ** list of GLOB patterns in PATTERN, as with ex= |
| 741 | ** |
| 742 | ** ex=PATTERN Omit any file that match PATTERN. PATTERN is a |
| 743 |
| --- src/tar.c | |
| +++ src/tar.c | |
| @@ -704,39 +704,42 @@ | |
| 704 | return zName; |
| 705 | } |
| 706 | |
| 707 | /* |
| 708 | ** WEBPAGE: tarball |
| 709 | ** URL: /tarball/VERSION/NAME.tar.gz |
| 710 | ** |
| 711 | ** Generate a compressed tarball for the check-in specified by VERSION. |
| 712 | ** The tarball is called NAME.tar.gz and has a top-level directory called |
| 713 | ** NAME. |
| 714 | ** |
| 715 | ** Alternatively, the VERSION can be specified using the r= query parameter. |
| 716 | ** All of the following URLs are equivalent: |
| 717 | ** |
| 718 | ** /tarball/release/xyz.tar.gz |
| 719 | ** /tarball?r=release&name=xyz.tar.gz |
| 720 | ** /tarball/xyz.tar.gz?r=release |
| 721 | ** /tarball?name=release/xyz.tar.gz |
| 722 | ** |
| 723 | ** Query parameters: |
| 724 | ** |
| 725 | ** name=[CKIN/]NAME The optional CKIN component of the name= parameter |
| 726 | ** identifies the check-in from which the tarball is |
| 727 | ** constructed. If CKIN is omitted and there is no |
| 728 | ** r= query parameter, then use "trunk". NAME is the |
| 729 | ** name of the download file. The top-level directory |
| 730 | ** in the generated tarball is called by NAME with the |
| 731 | ** file extension removed. |
| 732 | ** |
| 733 | ** r=TAG TAG identifies the check-in that is turned into a |
| 734 | ** compressed tarball. The default value is "trunk". |
| 735 | ** If r= is omitted and if the name= query parameter |
| 736 | ** contains one "/" character then the of part the |
| 737 | ** name= value before the / becomes the TAG and the |
| 738 | ** part of the name= value after the / is the download |
| 739 | ** filename. If no check-in is specified by either |
| 740 | ** name= or r=, then "trunk" is used. |
| 741 | ** |
| 742 | ** in=PATTERN Only include files that match the comma-separate |
| 743 | ** list of GLOB patterns in PATTERN, as with ex= |
| 744 | ** |
| 745 | ** ex=PATTERN Omit any file that match PATTERN. PATTERN is a |
| 746 |