Getting ready to clang-format everything...

[Carlsen, Robert W]

To all MOOSE users and developers:

We are planning to switch to a clang-format enforced code style.  In about 1 week from today, we will format all C++ code in the MOOSE repository to the new code style.

We'd prefer that you don't reformat existing code in the repository in until after we do the baseline reformat of everything.  You are, however, welcome to format changed/new lines of code you are working on.  The ".clang-format" file for the style is already in the repository along with an install script for git a pre-commit hook check.  You can also use tools like "git clang-format" that only reformat diff'd lines.

After the update, in-progress work will need to be rebased/updated.  We will provide scripts for rebasing your in-progress work across the big reformat commit.  You will probably want to get your editor ready to auto-format C/C++ code on save (although don't enable it until after we update MOOSE first).  Auto-format plugins/functionality is available for every editor/environment worth using (just google clang-format plugin [editor]).  CIVET will be updated to fail/reject PRs that don't follow the style and will print a diff of changes that need to be made to comply.

Stay tuned.

[john.m...@uconn.edu]

is this going to affect HPC resources?

[princessandsuperman]

This is just for the MOOSE framework repository (for now).

[John Mangeri]

OK... so will it compile on older g++? Ect? Or are clang compatible compilers going to be required?

--
You received this message because you are subscribed to a topic in the Google Groups "moose-users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/moose-users/FoKtoKa9FUg/unsubscribe.
To unsubscribe from this group and all its topics, send an email to moose-users+unsubscribe@googlegroups.com.
Visit this group at https://groups.google.com/group/moose-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/60fa7dfd-6cab-4566-b89f-bdcbc5a7253a%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Cody Permann]

John, This is just formatting. We happen to be using a clang tool to apply the formatting, but it's nothing more than whitespace changes. The only difficulty you will have on systems without clang is the ability to apply the formatting correctly on your own. We plan to make CIVET generate a patch for you in those cases. Say goodbye to a ton of messages from the maintainers about spacing problems in your code. It should be mostly automated moving forward.

On Thu, Mar 16, 2017 at 9:10 AM John Mangeri <john.m...@uconn.edu> wrote:

OK... so will it compile on older g++? Ect? Or are clang compatible compilers going to be required?

On Mar 15, 2017 5:21 PM, "princessandsuperman" <princessa...@gmail.com> wrote:

This is just for the MOOSE framework repository (for now).

On Wednesday, March 15, 2017 at 10:12:06 AM UTC-6, john.m...@uconn.edu wrote:

is this going to affect HPC resources?

--

You received this message because you are subscribed to a topic in the Google Groups "moose-users" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/moose-users/FoKtoKa9FUg/unsubscribe.

To unsubscribe from this group and all its topics, send an email to moose-users...@googlegroups.com.

Visit this group at https://groups.google.com/group/moose-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/60fa7dfd-6cab-4566-b89f-bdcbc5a7253a%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "moose-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to moose-users...@googlegroups.com.

Visit this group at https://groups.google.com/group/moose-users.

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAJC7Cwbsjw%3Do7sbUqeVTkHTHx85RK%3DkYOSy-fFoZ65GPS9t_Ew%40mail.gmail.com.

[Andrew....@csiro.au]

Could you please provide more explicit step-by-step details on how to get clang format working with emacs (and i guess other editors too).  I just want the C++ to be formatted correctly as i type.

 

On my Mac, with the MOOSE package provided by you, i see that there is a file /opt/moose/llvm-3.9.0/share/clang/clang-format.el, which i presume i have to load somehow in my ~/.emacs file.  When i try to do this, I get the message “File error: Cannot open load file, cl-lib”, so obviously that’s wrong.  Also, there is a file, projects/moose/.clang-format that I suppose I have to use somehow.

 

On my clusters, what do I do?  Do I have to get the admins to install clang-format (any version?), or more?

 

a

 

 

Ph: +61 7 3327 4497.  Fax: +61 7 3327 4666
Queensland Centre for Advanced Technologies
PO Box 883, Kenmore, Qld, 4069 
 

--

You received this message because you are subscribed to the Google Groups "moose-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to moose-users...@googlegroups.com.
Visit this group at https://groups.google.com/group/moose-users.

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CANjjvfQo-UBieFGfN7fTeemm0y8aOt3M0AmOnL0S33_x4Hgv9A%40mail.gmail.com.

[Andrew....@csiro.au]

Sorry, previous email would likely be infected by spam. Here's the content of the previous email:

[princessandsuperman]

http://clang.llvm.org/docs/ClangFormat.html#emacs-integration

[Daniel Schwen]

https://atom.io/packages/clang-format

:-)

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/e14be989-a169-431a-95da-aa0a3e027e0b%40googlegroups.com.

[Andrew....@csiro.au]

​Yes, i believe i followed the instructions at the link you mention, however, i got the error "File error: Cannot open load file, cl-lib" This was using the clang-format.el in /opt/moose/llvm-3.9.0/share/clang/clang-format.el (see email below for details).

Could you please provide more explicit instructions?

a

http://clang.llvm.org/docs/ClangFormat.html#emacs-integration

a

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/e14be989-a169-431a-95da-aa0a3e027e0b%40googlegroups.com.

[princessandsuperman]

I'm a vim user myself.  Something like this maybe: http://stackoverflow.com/questions/20678847/cannot-load-cl-lib-at-emacs-startup? clang-format is included with the clang compiler toolchain.  So any clang (compiler) install should already include clang-format.  Note that we use 3.9 or newer for our formatting.

[Cody Permann]

Andy, I don't know if any of us Emacs users have actually tried this step yet. I was waiting for the actual deployment so I wouldn't get spurious changes all over the place in the meantime. We'll share more lessons learned on getting your editors whipped into shape following the deployment. Looks like Robert's link is probably the fix you need here though.

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/0f49e256-228f-4a4f-9bab-086cb1bd55aa%40googlegroups.com.

[Andrew....@csiro.au]

OK, i think i’ll let you guys sort out this clang-format stuff and then tell me what to do. I downloaded Robert’s cl-lib.el, and it sort of worked, but upon loading it, emacs complained

Symbol’s function definition is void: declare-function

I don’t know if this is a big deal or not.

a

Ph: +61 7 3327 4497.  Fax: +61 7 3327 4666
Queensland Centre for Advanced Technologies
PO Box 883, Kenmore, Qld, 4069 
 

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAK06EuXL%3D4mto0VPiJPEF7SiG_q%2BmRmLPCppf6HTMi%3DYVmvr7A%40mail.gmail.com.

[Cody Permann]

Andy,

I loaded the emacs plugin today on my Mac and it worked out of the box. I didn't have to load the cl-lib.el file like you did. I'm running a fairly recent version of Emacs but I'm not sure if that's why you are seeing a problem and I'm not. You said it appears to be working though?

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/c6d241327f8c44c99a3989ecefdeba17%40exch3-cdc.nexus.csiro.au.

[Andrew....@csiro.au]

​
Sounds promising, thanks Cody. I'll report back after giving it a try, today hopefully.

a

Andy,

a

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAK06EuWSb7qELcsaoV_vmcPtfWfVmDWQJeGu5V9EMg3wF8UnSg%40mail.gmail.com.

[Cody Permann]

Also, for those emacs users out there, I've added the relevant portion of my ".emacs" configure to Robert's blog post (at the bottom). It turns on clang format so you can format files with a normal emacs key binding. I've also set it to automatically run clang format whenever you save any source file inside the MOOSE repository. It shouldn't affect source files in your own repositories.

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/1490129868677.99434%40csiro.au.

[Andrew....@csiro.au]

​I couldn't get this to work quite perfectly. I left some notes at the bottom of the blog entry on mooseframework.org

a

a

Andy,

a

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAK06EuWyT4JRd1a2ki1j5hrN5Q9uPbEmFrVE%3DR3pfq_H01JMaQ%40mail.gmail.com.

[Cody Permann]

I had a similar problem as you reported (over-aggressive formatting). I was able to fix it by re-ordering my hooks. I can now edit non-C++ files without having clang-format trying to format them.

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/1490179488418.83789%40csiro.au.

[Alex Lindsay]

I noticed that clang-format doesn't like the opening curly brace to be on its own line, but I thought the MOOSE style was for it to have its own line. You guys aren't using a custom style for your clang-format are you? Should we move then to the clang-format default?

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAK06EuX2YUeCpjnvTWAgXr4%3DQb62jrVx6PMYPVcuFBi6cUkLwg%40mail.gmail.com.

[Slaughter, Andrew E]

We are using a custom format, the is a ".clang-format" file in MOOSE at the top-level that sets up the "MOOSE" style.

To unsubscribe from this group and stop receiving emails from it, send an email to   moose-users+unsubscribe@googlegroups.com.

Visit this group at   https://groups.google.com/group/moose-users.
To view this discussion on the web visit   https://groups.google.com/d/msgid/moose-users/0f49e256-228f-4a4f-9bab-086cb1bd55aa%40googlegroups.com.
For more options, visit   https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to   moose-users+unsubscribe@googlegroups.com.

Visit this group at   https://groups.google.com/group/moose-users.
To view this discussion on the web visit   https://groups.google.com/d/msgid/moose-users/CAK06EuXL%3D4mto0VPiJPEF7SiG_q%2BmRmLPCppf6HTMi%3DYVmvr7A%40mail.gmail.com.
For more options, visit   https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to   moose-users+unsubscribe@googlegroups.com.

Visit this group at   https://groups.google.com/group/moose-users.
To view this discussion on the web visit   https://groups.google.com/d/msgid/moose-users/c6d241327f8c44c99a3989ecefdeba17%40exch3-cdc.nexus.csiro.au.
For more options, visit   https://groups.google.com/d/optout.

 --
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to  moose-users+unsubscribe@googlegroups.com.

Visit this group at  https://groups.google.com/group/moose-users.
To view this discussion on the web visit   https://groups.google.com/d/msgid/moose-users/CAK06EuWSb7qELcsaoV_vmcPtfWfVmDWQJeGu5V9EMg3wF8UnSg%40mail.gmail.com.
For more options, visit  https://groups.google.com/d/optout.


--
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to  moose-users+unsubscribe@googlegroups.com.

Visit this group at  https://groups.google.com/group/moose-users.
To view this discussion on the web visit  https://groups.google.com/d/msgid/moose-users/1490129868677.99434%40csiro.au.
For more options, visit  https://groups.google.com/d/optout.

 --
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to moose-users+unsubscribe@googlegroups.com.

Visit this group at https://groups.google.com/group/moose-users.
To view this discussion on the web visit  https://groups.google.com/d/msgid/moose-users/CAK06EuWyT4JRd1a2ki1j5hrN5Q9uPbEmFrVE%3DR3pfq_H01JMaQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.


--
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to moose-users+unsubscribe@googlegroups.com.

Visit this group at https://groups.google.com/group/moose-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/1490179488418.83789%40csiro.au.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to moose-users+unsubscribe@googlegroups.com.

Visit this group at https://groups.google.com/group/moose-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAK06EuX2YUeCpjnvTWAgXr4%3DQb62jrVx6PMYPVcuFBi6cUkLwg%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "moose-users" group.

To unsubscribe from this group and stop receiving emails from it, send an email to moose-users+unsubscribe@googlegroups.com.

Visit this group at https://groups.google.com/group/moose-users.

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/cb2bdded-a8b0-58a3-d903-4ddcacd29f19%40gmail.com.

[Alex Lindsay]

Got it, thanks!

To view this discussion on the web visit https://groups.google.com/d/msgid/moose-users/CAGWYgTkARFV4%3Dn5QaZr%3Dw%2ByQ%2Bgk1e66b9%3D0GXot6KzQKPCQPCw%40mail.gmail.com.