[hibernate-commits] [hibernate/hibernate-search] 3cca57: HSEARCH-2723 Refactor the documentation to make bu...

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/hibernate/hibernate-search
  Commit: 3cca573e964edd53c4b628389e2598da52925e3d
      https://github.com/hibernate/hibernate-search/commit/3cca573e964edd53c4b628389e2598da52925e3d
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Refactor the documentation to make built-in bridges more visible

We used to have a partial duplicate of the built-in bridges
documentation in the part about @Field, making it easy to miss part of
the documentation (including stuff about dates).

I removed the duplicate and merged it into the built-in bridges
documentation, then linked from the @Field documentation to the built-in
bridges documentation. This should make it less likely that someone
misses parts of the built-in bridges documentation.


  Commit: 28f7a6945ecf3b619dc0e2b7f2ef4c98437de8b8
      https://github.com/hibernate/hibernate-search/commit/28f7a6945ecf3b619dc0e2b7f2ef4c98437de8b8
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Mention @CalendarBridge in the documentation about built-in bridges


  Commit: c70758e08dde06739c1b48e9a19062d93e3c12bc
      https://github.com/hibernate/hibernate-search/commit/c70758e08dde06739c1b48e9a19062d93e3c12bc
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Reorder date/time-related paragraphs in the built-in bridge docs

... So as to avoid switching back and forth between java.util.Date and
java.time.


  Commit: 819b2fc5ee358193fe7f2d02564507c08aafd96a
      https://github.com/hibernate/hibernate-search/commit/819b2fc5ee358193fe7f2d02564507c08aafd96a
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Document built-in bridges for boolean and char

For some reason, they were not documented.


  Commit: 55da3a65a7f43ac3a8607fa910f419794ff7fc03
      https://github.com/hibernate/hibernate-search/commit/55da3a65a7f43ac3a8607fa910f419794ff7fc03
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/elasticsearch-integration.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Document built-in field bridges with Elasticsearch

In particular bridges for java.time types.


  Commit: f43584531152241fbc2a0720da2fadfdbb739cce
      https://github.com/hibernate/hibernate-search/commit/f43584531152241fbc2a0720da2fadfdbb739cce
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Do not document short as being indexed as numeric by default

Because it isn't.


  Commit: cea1058df5946bf94f0621fd110418e35833bc75
      https://github.com/hibernate/hibernate-search/commit/cea1058df5946bf94f0621fd110418e35833bc75
  Author: Yoann Rodière <yoann at hibernate.org>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 Remove the warning about resolution on @DocumentId

We do not check this at runtime, so it is not "impossible" to have a
document ID with a date bridge whose resolution is lower than the
milisecond. It could even work if all the values have a zero time
(00:00), for instance.

I'm not saying it makes sense, but it's about as dangerous as putting a
random custom field bridge on the document ID without taking care of
preserving information, so _if_ we warn about this, we should not warn
about this _here_.


  Commit: 3a9a0e08212c2e5c2c9bf75fc8784c2389e3fac0
      https://github.com/hibernate/hibernate-search/commit/3a9a0e08212c2e5c2c9bf75fc8784c2389e3fac0
  Author: Guillaume Smet <guillaume.smet at gmail.com>
  Date:   2017-05-12 (Fri, 12 May 2017)

  Changed paths:
    M documentation/src/main/asciidoc/mapping.asciidoc

  Log Message:
  -----------
  HSEARCH-2723 integer should be int


Compare: https://github.com/hibernate/hibernate-search/compare/f6e972f42a09...3a9a0e08212c